notion-md-gen

README

notion-md-gen

notion-md-gen allows you to use Notion as a CMS for pages built with any static site generators. You can use it as a cli or even automate your blog repo to update itself with the Github Action.

Requisites

• Notion database for your articles.
• Notion API secret token.
• A blog by any static site generators.

Setup

install.sh

curl -sSf https://raw.githubusercontent.com/bonaysoft/notion-md-gen/master/install.sh | sh

webi (not ready)

curl https://webinstall.dev/notion-md-gen | bash

brew (not ready)

brew install notion-md-gen

Usage

CLI

cd your-blog-dir
notion-md-gen init
notion-md-gen

Github Action

The installation command tool is helpful for local debugging. If you do not want to debug locally, you can also copy the configuration file to your project and run it directly through GitHubAction. You can see the example config in example/notion-md-gen.yaml.

To use it as a Github Action, you can follow the example of the repository in .github/worflows/notion.yml.

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

Special thanks

• xzebra

I based this code on https://github.com/xzebra/notion-blog

License

notion-md-gen is under the MIT license. See the LICENSE file for details.