This repository has been archived by the owner on Apr 29, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 13
/
README.md
72 lines (48 loc) · 3.13 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# Notion Blog React
[**English**](#) | [简体中文](README.zh-CN.md)
> A fast serverless Blog powered by Notion.
A Blog powered by [Notion](https://notion.so), built with [React](https://reactjs.org), [Next.js](https://nextjs.org), [tailwindcss](https://tailwindcss.com), [TypeScript](https://www.typescriptlang.org/), [Notion-Api-Worker](https://github.com/splitbee/notion-api-worker), [React-Notion-X](https://github.com/NotionX/react-notion-x/) and more.
## Features
Please see the **[features section](https://github.com/NotionX/react-notion-x#features)** on React-Notion-X by [NotionX](https://github.com/NotionX/).
And also, you can...
- Easily change the things you want by editing [`.env`](./.env.example) file.
- Support [Google Analytics](https://analytics.google.com/) & [Splitbee Analytics](https://splitbee.io/).
- Self host notion-api by using [Cloudflare Workers](https://workers.dev). (Default [notion-api](https://notion-api.splitbee.io) By Splitbee)
- Use your favorite Google Fonts.
- Use your own domain.
## Performance
![Notion-Blog-React-Lighthouse-Performance-Desktop](https://cdn.harrly.com/project/GitHub/Notion-Blog-React/img/Lighthouse-Performance-Desktop.png)
- Use [Lighthouse](https://developers.google.com/web/tools/lighthouse) for testing
## Known Issues
- ❌ Some Notion blocks is not supported. (Please see [here](https://github.com/NotionX/react-notion-x#supported-blocks) for more info.)
## How to deploy
Please visit Notion Blog React [Documentation](https://docs.harrly.com/docs/notion-blog-react) for more details.
## Improvement / Plans
- [x] Add [React-Notion-X](https://github.com/NotionX/react-notion-x) supported or Mix current api with [React-Notion-X](https://github.com/NotionX/react-notion-x).
- [ ] Add PostView.
- [x] Using [Notion Official API](https://developers.notion.com/). (Blogging entirely using Notion's official API is finished and hope to release it soon in the future)
- [ ] Add Tag.
## Related (Examples or Technology being used)
- [Splitee Blog](https://splitbee.io/blog) (using React-Notion, contributor of React-Notion)
- [timo.sh](https://timo.sh/) (using React-Notion, contributor of React-Notion)
- [TransitiveBullsh.it](https://transitivebullsh.it/) (using React-Notion-X, contributor of React-Notion-X)
- [Spencerwoo's Blog](https://blog.spencerwoo.com/) (using React-Notion-X)
- [Vercel](https://vercel.com)
- [Cloudflare Workers](https://workers.dev)
- [React](https://reactjs.org)
- [Next.js](https://nextjs.org)
- [tailwindcss](https://tailwindcss.com)
- [TypeScript](https://www.typescriptlang.org/)
- [Notion-Api-Worker](https://github.com/splitbee/notion-api-worker)
- [React-Notion-X](https://github.com/NotionX/react-notion-x)
- [Google Analytics](https://analytics.google.com/)
- [Splitee](https://splitbee.io/)
## Alternatives
> Turn Notion to Blog/Page
- [React-Notion](https://github.com/splitbee/react-notion)
- [React-Notion-X](https://github.com/NotionX/react-notion-x)
- [Super.so](https://super.so/)
- [Fruition](https://fruitionsite.com/)
## Credits
Copyright (c) 2022 Harry Yep
- All Authors & Contributors who own its repository