https://github.com/whatasame/notion-to-jekyll
GitHub action for synchronizing Notion to Jekyll
https://github.com/whatasame/notion-to-jekyll
cms github-actions jekyll notion syncronization
Last synced: 6 months ago
JSON representation
GitHub action for synchronizing Notion to Jekyll
- Host: GitHub
- URL: https://github.com/whatasame/notion-to-jekyll
- Owner: whatasame
- Created: 2023-11-07T13:40:49.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-03T09:18:49.000Z (over 1 year ago)
- Last Synced: 2025-03-21T13:28:36.175Z (9 months ago)
- Topics: cms, github-actions, jekyll, notion, syncronization
- Language: TypeScript
- Homepage:
- Size: 1.45 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Notion to Jekyll
No more exporting and uploading your Notion posts to your Jekyll blog! Automate it with Notion to Jekyll.
Notion to Jekyll is a GitHub action that automatically synchronizes posts written in Notion with Jekyll blogs.
> [!CAUTION]
>
> Notion to Jekyll **deletes all posts** that do not exist in Notion. If you want to keep your existing posts, you need
> to move them to Notion.
See other languages documentation here
* [🇰🇷 í•œêµì–´](./docs/ko/README.md)
## Getting started
In order to use Notion to Jekyll, you need to prepare three things. If you are not ready, please refer to the link for
each item.
1. [Create Notion to Jekyll database template](docs/en/notion-to-jekyll-template.md)
2. [Issue Notion API key and create integration](docs/en/notion-api-key-integration.md)
3. [Set up GitHub repository](docs/en/github-setting.md)
If you are ready, please proceed to the next step and set up GitHub action.
### GitHub action setting
Create a `.github/workflows/notion-to-jekyll.yml` file in your Jekyll blog repository and write the following.
```yaml
name: Notion to Jekyll
on:
schedule:
- cron: '0 0 * * *' # Run every midnight
workflow_dispatch:
permissions:
contents: write # Required for GitHub action to save files
jobs:
notion-to-jekyll:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Notion to Jekyll synchronization
uses: whatasame/notion-to-jekyll@v0 # latest version
with:
notion_api_key: ${{ secrets.NOTION_API_KEY }}
notion_database_id: ${{ secrets.NOTION_DATABASE_ID }}
```
Now, the posts you write in Notion will be automatically synchronized with your Jekyll blog every midnight. Or you can
run GitHub action manually.
## GitHub action options
Notion to Jekyll provides the following options.
| Option name | Required | Default value | Description |
|----------------------|----------|--------------------------------------|-------------------------------------------|
| `notion_api_key` | Required | - | Notion API key |
| `notion_database_id` | Required | - | Notion database ID |
| `post_dir` | Optional | `_posts` | Target post directory |
| `post_layout` | Optional | `post` | Layout value of Jekyll front matter |
| `post_layout_skip` | Optional | `false` | Whether to skip generating layout variable |
| `commit_user_name` | Optional | `{username}` | Git user name |
| `commit_email` | Optional | `{username@users.noreply.github.com` | Git user email |
| `commit_author` | Optional | `{username}` | Commit author |
| `commit_message` | Optional | `Synchronized by Notion to Jekyll` | Commit message |
For example, if you want to change the `post_dir` option, you can write as follows.
```yaml
- name: Notion to Jekyll synchronization
uses: whatasame/notion-to-jekyll@v0
with:
notion_api_key: ${{ secrets.NOTION_API_KEY }}
notion_database_id: ${{ secrets.NOTION_DATABASE_ID }}
post_dir: _my_posts_dir
```
## FAQ
### Permission to repository denied to github-actions[bot]
You may get the following error during the synchronization process.
```
error: remote: Permission to {username}/{repository}.git denied to github-actions[bot].
fatal: unable to access 'https://github.com/{username}/{repository}.git/': The requested URL returned error: 403
```
This problem occurs because GitHub action does not have write permission to the repository. To solve this problem,
please ensure that you have set up the GitHub workflow permission in `notion-to-jekyll.yml` file.
```yaml
permissions:
contents: write
```
## Contributing
Notion to Jekyll is waiting for your contribution. If you have any problems or improvements while using it, please feel
free to leave an issue.