From fdfdd7fe23cceebf58260af21ba92b28554eab7b Mon Sep 17 00:00:00 2001 From: Kaede Date: Tue, 1 Jun 2021 14:42:09 +0000 Subject: [PATCH] Update README via CircleciBot - 152 --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9594598..f60ae13 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ *         [Advanced usage](#advanced-usage) *     [Getting Started](#getting-started) *         [Prepare](#prepare) + *         [Run NotionDown](#run-notiondown) *         [UnitTest Examples](#unittest-examples) *         [CI Build Script](#ci-build-script) *         [Showcase Jobs](#showcase-jobs) @@ -44,7 +45,7 @@ What can NotionDown 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%2F20210601%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20210601T104939Z&X-Amz-Expires=86400&X-Amz-Signature=4678c957e70c04c9dd660776f791c9e0a62c190d3411677e463e942aea013d5c&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=20210601T144157Z&X-Amz-Expires=86400&X-Amz-Signature=7be07a7cb69fa64fdeda95bb6eebcde208c924c910708e191cf6745d22a58877&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. @@ -71,7 +72,9 @@ Check [here](https://github.com/kaedea/notion-down/blob/master/dist/parse_readme 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` : +### Run NotionDown + +Basically just run `notion-down/main.py` : ```Bash # Run with cli cmd @@ -88,6 +91,8 @@ PYTHONPATH=./ python main.py \ ``` +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. ### UnitTest Examples @@ -116,5 +121,5 @@ See the usage showcase jobs at [/jobs](/jobs), and jobs outputs at [/dist](/dist \ No newline at end of file