https://github.com/unix/notion-board-box
https://github.com/unix/notion-board-box
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/unix/notion-board-box
- Owner: unix
- License: mit
- Created: 2020-06-18T12:44:39.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-19T13:37:56.000Z (about 5 years ago)
- Last Synced: 2025-03-28T19:55:03.880Z (3 months ago)
- Size: 65.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Notion board box
Update board information on Notion to Gist!
---
## What is
I'm big fan of Notion, and I enjoy recording my works or goals on the Notion board.
This project helps you automatically synchronize Notion's baord infomation to the GitHub home page (Gist),
you can browse how it works on my GitHub home page. It updates infomation every `15 minutes`,
you can also change the [settings](https://github.com/unix/notion-board-box/blob/77b57507ca71dd0ab1e1a3260dfebfa617f0dd09/.github/workflows/goals.yml#L7) yourself.
## Setup
1. You need to have a [Notion](https://www.notion.so/) page, and that contains **Board**. e.g. [goals](https://www.notion.so/9d274b2fc30444358ef988c0d1d884b8)
2. Create a new public [GitHub Gist](https://gist.github.com/)
3. [Create a token](https://github.com/settings/tokens/new) with the gist scope and copy it.
## Usage
**Just copy [goals.yml](https://github.com/unix/notion-board-box/blob/master/.github/workflows/goals.yml) file to any of your projects,**
modify the configs as you like, and it work.
## Parameters in yaml file
- `GH_TOKEN`: The GitHub token generated above, you can configure it in project's `settings/secrets`.
- `id`: Your Gist id.
- `page`: Your Notion page id.
- `url`: External links, support for markdown syntax.
## License
[MIT](https://github.com/unix/notion-board-box/blob/master/LICENSE)