Skip to content

Commit ef72d7b

Browse files
authored
Update README.md
1 parent 9ca7f63 commit ef72d7b

File tree

1 file changed

+2
-90
lines changed

1 file changed

+2
-90
lines changed

README.md

Lines changed: 2 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,5 @@
11
# Notion2Jekyll
22
[![PyPI version](https://badge.fury.io/py/notion2jekyll.svg)](https://badge.fury.io/py/notion2jekyll)
33

4-
Jekyll Exporter makes your notion page to [Jekyll Post Markdown](https://jekyllrb-ko.github.io/docs/posts/) file. This is using [notion-py](https://github.com/jamalex/notion-py) to export notion page to markdown.
5-
6-
Notion2Jekyll provides these features.
7-
8-
1. Exports your notion page to the markdown file named as the jekyll-post title:
9-
`yyyy-m-dd-<your page's title>`
10-
11-
> If there is no **Created Date** in the notion page's property, the exporter will automatically set the file name as title only.
12-
13-
14-
2. Puts [front matter](https://jekyllrb.com/docs/step-by-step/03-front-matter/)s to the markdown file.
15-
16-
- `tags`
17-
18-
- `layout: post`
19-
20-
> Even if your page doesn't have the tag property, the exporter will work.
21-
22-
3. Download images in your notion page, and automatically set the image path in the md file
23-
24-
`You need to rename the path when you upload in your blog`
25-
26-
## Installation
27-
28-
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install notion2jekyll.
29-
30-
```Bash
31-
$pip install notion2jekyll
32-
```
33-
34-
## Usage_Command Line
35-
36-
```Bash
37-
$python -m notion2jekyll
38-
#Markdown file name: <output file name(without .md)>
39-
#Token_v2: <your token_v2 on notion.so>
40-
#Notion Page Url: <your notion page to export>
41-
```
42-
43-
## Usage in Python
44-
45-
> I changed the way to use the jekyll exporter. Please follow these examples.
46-
47-
### With nothing
48-
```Python
49-
from notion2jekyll import *
50-
51-
export_cli()
52-
```
53-
54-
### With token_v2 & url
55-
```Python
56-
from notion2jekyll import *
57-
token_v2 = #<your notion token_v2>
58-
url = #<your notion page url>
59-
60-
export_out(url,token_v2)
61-
```
62-
63-
### With token_v2 & url & Notion-py Block
64-
```Python
65-
from notion2jekyll import *
66-
67-
token_v2 = #<your notion token_v2>
68-
url = #<your notion page url>
69-
70-
client = NotionClient(token_v2=token_v2)
71-
block = client.get_block(url)
72-
73-
export_in(block,client)
74-
```
75-
76-
77-
## Aditional Info
78-
79-
- Exporter will make the md file and images in the folder named `posts` and `posts/<your block title>`
80-
81-
- The url should be the page that you want to export.
82-
83-
- The front matter in the markdown will be different based on your jekyll blog variables. So, change the front matters when you finish the export, or change the code in this project.
84-
85-
## Contributing
86-
87-
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
88-
89-
Please make sure to update tests as appropriate.
90-
91-
## License
92-
93-
[MIT](https://choosealicense.com/licenses/mit/)
4+
# Notion2Jekyll is merged with Notion2md. Please use Notion2md to export your notion page
5+
[https://github.com/echo724/notion2md](https://github.com/echo724/notion2md)

0 commit comments

Comments
 (0)