Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaedea/notion-down
Notion >> Markdown. Python utility that converts Notion pages into MD files, along with intergation to build static webpages such as Hexo | 自动从 Notion 笔记生成 MD 文件，并部署到 Hexo 静态博客 | Notion Pages より Markdown Files をコンバートする、更に Hexo Webpages までの自動化も可能
https://github.com/kaedea/notion-down
devops hexo markdown notion notion-blog notion-markdown
Last synced: 6 days ago
JSON representation
Notion >> Markdown. Python utility that converts Notion pages into MD files, along with intergation to build static webpages such as Hexo | 自动从 Notion 笔记生成 MD 文件，并部署到 Hexo 静态博客 | Notion Pages より Markdown Files をコンバートする、更に Hexo Webpages までの自動化も可能
- Host: GitHub
- URL: https://github.com/kaedea/notion-down
- Owner: kaedea
- Created: 2021-05-05T17:22:43.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-02T08:23:08.000Z (over 1 year ago)
- Last Synced: 2024-08-07T23:53:53.180Z (3 months ago)
- Topics: devops, hexo, markdown, notion, notion-blog, notion-markdown
- Language: Python
- Homepage: https://kaedea.notion.site/NotionDown-README-d3463f3d398743879d663caf87efa029
- Size: 458 KB
- Stars: 119
- Watchers: 2
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Notion Down
[🇨🇳](https://www.kaedea.com/2021/05/01/devops/project-notion-down/) [🇯🇵](https://www.kaedea.com/2021/05/01/devops/project-notion-down-jp/)
[Notion Down](https://github.com/kaedea/notion-down), python tools that convert Notion blog pages into Markdown files, along with integration to build static webpages such as Hexo. Its inspiration and goal is to __avoid separation of writing__ by keep writing drafts or posts within [notion.so](http://notion.so) and then publish them into MD webpages automatically.
* [Notion Down](#notion-down)
* [Examples](#examples)
* [Features](#features)
* [Hot It Works](#hot-it-works)
* [Basic usage](#basic-usage)
* [Advanced usage](#advanced-usage)
* [Getting Started](#getting-started)
* [Prepare](#prepare)
* [Run NotionDown](#run-notiondown)
* [CI Build Script](#ci-build-script)
* [Showcase Jobs](#showcase-jobs)
* [UnitTest Examples](#unittest-examples)
## Examples
[kaedea.com](http://www.kaedea.com)
[hexo.kaedea.com](http://hexo.kaedea.com)
[基于 Notion 的笔记写作和博客分享自动化方案](https://www.kaedea.com/2021/05/20/devops/notion-to-markdown-file-automating-solution/)
## Features
What can NotionDown do now:
- Notion pages to MarkDown files
- ~~Basic Notion PageBlocks parsing~~
- ~~Notion images refer & download~~
- ~~Notion nested list blocks~~
- ~~Notion obfuscated-links parsing~~
- ~~Notion table block (Collection)~~
- Notion subpage / alias link parsing
- Advanced Notion PageBlocks support
- ~~Pullquote Blocks (Notion ColumnList)~~
- Image source replacing
- ~~Replace notion image url with image file~~
- Replace notion image url with other CDN urls
- Notion page embed blocks
- Writing optimized integration
- ~~Noton custom `ShortCode` blocks that control parametered MD files generating~~
- ~~Mixed CN-EN text separation format~~ ([by pangu](https://github.com/vinta/pangu))
- ~~Spelling inspect~~ (by [pycorrector](https://github.com/shibing624/pycorrector))
- HEXO Integration
- ~~HEXO page properties config~~
- ~~HEXO generate~~
- HEXO tags plugin
- PyPI Publish
- Notion APIs
- ~~notion-py (3rd party)~~
- notion-sdk (official)
## Hot It Works
NotionDown read Notion pages data using [notion-py](https://github.com/jamalex/notion-py), and then write pages into MD files.
### Basic usage
> notion-down >> Notion APIs (notion-py) >> Notion pages data >> generating MD files
### Advanced usage
> WebHook >> notion-down >> Notion APIs (notion-py) >> Notion pages data >> generating MD files >> Copy into Hexo source >> generating webpages >> push to GitHub pages
## Getting Started
### Prepare
To get started with NotionDown, you should:
1. Prepare your Notion username(email) and password, or directly use `notion_token_v2`.
1. Prepare `public notion blog_url` as root post for NotionDown to get the pages you want to handle.
1. Run `notion-down/main.py` with your configs.
Check [here](https://github.com/kaedea/notion-down/blob/master/dist/parse_readme/notiondown_gettokenv2.md) to get `notion_token_v2`.
Duplicate [NotionDown Posts Template](https://www.notion.so/kaedea/NotionDown-Posts-Template-f77f3322915a4ab48caa0f2e76e9d733) to your own notion and take it as `blog_url` (or you can just use your existing blog post url). Note that, for now the root page should be public as well as placed in root path of notion workspace.
### Run NotionDown
Basically just run `notion-down/main.py` :
```Bash
# Run with cli cmd
PYTHONPATH=./ python main.py \
--blog_url \
--token_v2
--username # Only when token_v2 is not presented
--password # Only when token_v2 is not presented
# or
PYTHONPATH=./ python main.py \
--config_file '.config_file.json'
# Your can configure notion-down args by cli-args, config_file or SysEnv parameters
# Priority: cli args > config_file > SysEnv parameters > NotionDown default
```
For custom configurations in details, see [Custom Configurations](https://github.com/kaedea/notion-down/blob/master/dist/parse_readme/notiondown_custom_configs.md).
Also check the following procedures as showcase usages for NotionDown.
### CI Build Script
See building script at `/.circleci/config.yaml`.
- `test-build-readme`: CircleCI jobs generating README for this repo.
- `test-build-hexo`: CircleCI jobs generating Hexo posts for [https://github.com/kaedea/notion-down-hexo-showcase](https://github.com/kaedea/notion-down-hexo-showcase).
- `test-run-pycorrector`: CircleCI jobs that executing spelling check for the test posts.
### Showcase Jobs
See the usage showcase jobs at [/jobs](/jobs), and jobs outputs at [/dist](/dist).
- [README generating](/jobs/parse_readme/)
- [Notion sample post generating](/jobs/parse_sample_posts/)
- [HEXO public generating](/jobs/parse_sample_posts_for_hexo/)
- Notion image page source replacing (WIP)
### UnitTest Examples
See unittest cases at `test/`.
---
> This page is generated by [notion-down](https://github.com/kaedea/notion-down) from [notion.so NotionDown-README](https://www.notion.so/kaedea/NotionDown-README-d3463f3d398743879d663caf87efa029).