https://github.com/nonacosa/notion-site

Build any website for free with Notion automation | 使用 Notion + Hugo 免费自动化构建任何网站
https://github.com/nonacosa/notion-site

github-actions notion notion-blog

Last synced: 5 days ago
JSON representation

Build any website for free with Notion automation | 使用 Notion + Hugo 免费自动化构建任何网站

• Host: GitHub
• URL: https://github.com/nonacosa/notion-site
• Owner: nonacosa
• License: mit
• Created: 2022-11-19T13:03:38.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-11-26T06:47:01.000Z (29 days ago)
• Last Synced: 2024-12-17T03:08:48.560Z (8 days ago)
• Topics: github-actions, notion, notion-blog
• Language: Go
• Homepage: https://notion.zhuang.me/
• Size: 29.6 MB
• Stars: 45
• Watchers: 2
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# notion-site

[![](https://img.shields.io/github/v/release/nonacosa/notion-site.svg)](https://github.com/nonacosa/notion-site/releases)

[![](https://img.shields.io/github/license/nonacosa/notion-site.svg)](https://github.com/nonacosa/notion-site/blob/master/LICENSE)

**notion-site** is an open source software for a custom website based on [Notion](https://www.notion.so/) and [Hugo](https://gohugo.io/), and you can find your favorite template as your blog or documentation site among the hundreds of templates in the [Hugo Template Store](https://themes.gohugo.io/).

| Example                         | notion page |

|---------------------------------| --- |

| [doc](https://notion.zhuang.me) | [notion-page](https://zhuangwenda.notion.site/2bd00e5dfff3449ba81e0142f8af9bbb?v=065c41ad42be4683966e10f476e60afd) |

| [blog](https://blog-nonacosa.vercel.app/)    | [notion-page](https://zhuangwenda.notion.site/df7fb0e4e0114268b973f9d3e9a39982?v=557485cf3f564002acbdfd97c17ceb6f) |

 

![](img/notion-site.png)

## Requisites

- Notion Database id for your articles.

- Notion API secret token.

## Setup

### Unix system install

```bash

curl -sSf https://raw.githubusercontent.com/nonacosa/notion-site/master/install.sh | sh

```

 

## Debug local

```bash

cd your-hugo-site

notion-site init

# edit notion-site.yml your datatbse id and .env file notion secret

notion-site

```

### 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 [notion-site-doc](https://github.com/nonacosa/notion-site-doc/blob/main/.github/workflows/builder.yml).

To use it as a Github Action, you can use the template  of the repository

in [.github/worflows/notion.yml](.github/workflows/notion.yml).

## Contributing

See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.

## Special thanks

- [go-notion](https://github.com/dstotijn/go-notion)

- [xzebra](https://github.com/xzebra)

- [saltbo](https://github.com/saltbo)

 

## License

notion-site is under the MIT license. See the [LICENSE](/LICENSE) file for details.