Skip to content

Commit

Permalink
Update README via CircleciBot - 148
Browse files Browse the repository at this point in the history
  • Loading branch information
kaedea committed Jun 1, 2021
1 parent b8ef4d4 commit 9ad824a
Showing 1 changed file with 38 additions and 8 deletions.
46 changes: 38 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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~~
Expand All @@ -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.

Expand All @@ -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. <br>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 <Notion Post Url> \
--token_v2 <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).

Expand All @@ -76,6 +106,6 @@ See the usage showcase jobs at [/jobs](/jobs), and jobs outputs at [/dist](/dist


<!-- Generated by NotionPageWriter
notion-down.version = 0.0.1
notion-down.revision = b'd30cc42'
-->
notion-down.version = 0.1.0
notion-down.revision = b'f80d6bb'
-->

0 comments on commit 9ad824a

Please sign in to comment.