Skip to content

Commit

Permalink
Merge pull request #18 from kaedea/deploy/readme
Browse files Browse the repository at this point in the history
Update README via CircleciBot - 152
  • Loading branch information
kaedea authored Jun 1, 2021
2 parents 53550d7 + fdfdd7f commit b21812a
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.

Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -116,5 +121,5 @@ See the usage showcase jobs at [/jobs](/jobs), and jobs outputs at [/dist](/dist

<!-- Generated by NotionPageWriter
notion-down.version = 0.1.0
notion-down.revision = b'01f8e10'
notion-down.revision = b'53550d7'
-->

0 comments on commit b21812a

Please sign in to comment.