GitHub Action
@narkdown/awesome-reading-list
Create your own Awesome Reading List sync with Notion Database!
- Duplicate this Notion database template.
- Create a Notion Account.
- Create a Notion API integration & Get Token.
- Share a database with your integration.
- Create a new public GitHub Gist.
- Create a token with the
gist
scope and copy it.
-
Go to the repo Settings > Secrets
-
Add the following environment variables:
-
NOTION_API_TOKEN: The Notion token generated above.
-
NOTION_DATABASE_URL: The Notion database url duplicated above.
-
GIST_ID: The ID of the gist you created above
https://gist.github.com/username/287da0b33fc7d5b5848944f90f3600b7 |----------- Gist ID ----------|
-
GIST_TOKEN: The GitHub token generated above.
-
-
Your awesome reading list will be deployed at 00:00 AM (UTC) on everyday. You can trigger action manually.
-
Add your reading list to Notion database. You can use extensions like Notion Web Clipper or Save to Notion.
If you want to generate your own markdown using Notion Database data, you can customize template.
- Modify templates/default-template.md or Create new template file.
npm install && npm run build
- Change
narkdown/awesome-reading-list@main
to{your username}/awesome-reading-list@main
in .github/workflows/CI.yml
Required Notion API Key. How to get Notion API Key
Required Notion Database URL.
Required Personal access token for updating gist.
Required Id of the gist to be updated.
Show advanced input options
Name of the file to be deployed on gist.
Default awesome-reading-list.md
EJS template file path.
Default default-template.md
Timezone ID used to parse date properties.
Default Asia/Seoul
Date formatting rules used to parse data properties.
Default yyyy-MM-dd HH:mm:ss
Database query sorting criteria. created_time
| last_edited_time
Default created_time
Database query sorting direction. ascending
| descending
Default descending