Skip to content

Commit 67f89b6

Browse files
committed
feat:Add markdown and notion-site image
1 parent 7a49c43 commit 67f89b6

File tree

3 files changed

+57
-2
lines changed

3 files changed

+57
-2
lines changed

README.md

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,57 @@
1-
Build an efficient blog or content Sites based on Notion + Hugo
1+
# notion-site
2+
3+
Read Notion-Site Doc: https://ns-doc.env.wtf,And the documentation is built on [this Notion page](https://zhuangwenda.notion.site/2bd00e5dfff3449ba81e0142f8af9bbb?v=065c41ad42be4683966e10f476e60afd)
4+
5+
![](img/notion-site.png)
6+
7+
[![](https://img.shields.io/github/v/release/pkwenda/notion-site.svg)](https://github.com/bonaysoft/notion-md-gen/releases)
8+
[![](https://img.shields.io/github/license/pkwenda/notion-site.svg)](https://github.com/bonaysoft/notion-md-gen/blob/master/LICENSE)
9+
10+
**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/).
11+
12+
## Requisites
13+
- Notion Database id for your articles.
14+
- Notion API secret token.
15+
16+
17+
## Setup
18+
19+
### install.sh
20+
21+
```bash
22+
curl -sSf https://raw.githubusercontent.com/pkwenda/notion-site/master/install.sh | sh
23+
```
24+
25+
26+
## Usage
27+
28+
29+
30+
```bash
31+
cd your-hugo-site
32+
notion-site init
33+
notion-site
34+
```
35+
36+
### Github Action
37+
38+
> 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](example/notion-md-gen.yaml).
39+
40+
To use it as a Github Action, you can use the template of the repository
41+
in [.github/worflows/notion.yml](.github/workflows/notion.yml).
42+
43+
## Contributing
44+
45+
See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
46+
47+
## Special thanks
48+
49+
- [go-notion](https://github.com/dstotijn/go-notion)
50+
- [xzebra](https://github.com/xzebra)
51+
- [saltbo](https://github.com/saltbo)
52+
53+
54+
55+
## License
56+
57+
notion-site is under the MIT license. See the [LICENSE](/LICENSE) file for details.

go.mod

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ go 1.19
44

55
require (
66
github.com/Masterminds/sprig v2.22.0+incompatible
7-
github.com/alexeyco/simpletable v1.0.0
87
github.com/briandowns/spinner v1.18.0
98
github.com/dlclark/regexp2 v1.7.0
109
github.com/druidcaesa/gotool v0.0.0-20220613023420-645c641d1304

img/notion-site.png

128 KB
Loading

0 commit comments

Comments
 (0)