From 9ad824a98d9e00c1aa286a708876d80d53749feb Mon Sep 17 00:00:00 2001 From: Kaede Date: Tue, 1 Jun 2021 10:28:06 +0000 Subject: [PATCH] Update README via CircleciBot - 148 --- README.md | 46 ++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 38 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a7b397f..820acc2 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ ## Features -What can notion-down do now: +What can NotionDown do now: - Notion pages to MarkDown files - ~~Basic Notion PageBlocks parsing~~ @@ -35,7 +35,7 @@ What can notion-down do now: ## Hot It Works -![NotionDown Workflows](https://s3.us-west-2.amazonaws.com/secure.notion-static.com/21da4ef8-bdce-4d8a-8691-8d6cf4e726cd/NotionDown.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAT73L2G45O3KS52Y5%2F20210530%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20210530T131929Z&X-Amz-Expires=86400&X-Amz-Signature=ab660a707312551e5edd4fef1111bdd364f840e4fc73036c889237e0326b003b&X-Amz-SignedHeaders=host) +![NotionDown Workflows](https://s3.us-west-2.amazonaws.com/secure.notion-static.com/21da4ef8-bdce-4d8a-8691-8d6cf4e726cd/NotionDown.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAT73L2G45O3KS52Y5%2F20210601%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20210601T102756Z&X-Amz-Expires=86400&X-Amz-Signature=1e03b62459319533468dfa753645429768bb22f32e9384198cf6320c370cdeef&X-Amz-SignedHeaders=host) NotionDown read Notion pages data using [notion-py](https://github.com/jamalex/notion-py), and then write pages into MD files. @@ -49,17 +49,47 @@ NotionDown read Notion pages data using [notion-py](https://github.com/jamalex/n ## Getting Started -Set `notion_token_v2` at System ENV or `config.py` first, and then check the following procedures.
Check [here](https://github.com/kaedea/notion-down/blob/master/dist/parse_readme/notiondown_gettokenv2.md) to get notion_token_v2. +### Prepare + +To get started with NotionDown, you should: + +1. Prepare `notion_token_v2`. +1. Prepare `public notion blog_url` as root page for NotionDown to get the pages your want to work with. +1. Run `notion-down/main.py` in your way. + +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 `notion-down/main.py` : + +```Bash +# Run with cli cmd +PYTHONPATH=./ python main.py \ + --blog_url \ + --token_v2 + +# 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 +``` + + +Also check the following procedures as showcase usages for NotionDown. ### UnitTest Examples -See unitest cases at `/test`. +See unittest cases at `/test`. ### CI Build Script See building script at `/.circleci/config.yaml`. -### Showcases +### Showcase Jobs See the usage showcase jobs at [/jobs](/jobs), and jobs outputs at [/dist](/dist). @@ -76,6 +106,6 @@ See the usage showcase jobs at [/jobs](/jobs), and jobs outputs at [/dist](/dist +notion-down.version = 0.1.0 +notion-down.revision = b'f80d6bb' +--> \ No newline at end of file