mirror of
https://github.com/d0zingcat/NotionNext.git
synced 2026-05-14 07:26:52 +00:00
Update README.md
This commit is contained in:
75
README.md
75
README.md
@@ -1,7 +1,5 @@
|
||||
# NotionNext
|
||||
|
||||
一个使用 NextJS + Notion API 实现的,部署在 Vercel 上的静态博客系统。为Notion和所有创作者设计。
|
||||
|
||||
<p>
|
||||
<a aria-label="GitHub commit activity" href="https://github.com/tangly1024/NotionNext/commits/main" title="GitHub commit activity">
|
||||
<img src="https://img.shields.io/github/commit-activity/m/tangly1024/NotionNext?style=for-the-badge"/>
|
||||
@@ -17,74 +15,20 @@
|
||||
</a>
|
||||
</p>
|
||||
|
||||
演示地址:[https://preview.tangly1024.com/](https://preview.tangly1024.com/)
|
||||
一个使用 NextJS + Notion API 实现的,部署在 Vercel 上的静态博客系统。为Notion和所有创作者设计。
|
||||
|
||||
## 继承自Nobelium的亮点 ✨
|
||||
|
||||
**🚀 秒开,设备全适配**
|
||||
## 预览效果
|
||||
|
||||
- 快速的页面渲染和响应式设计
|
||||
- 高效编译器的快速静态页面生成
|
||||
|
||||
**🤖 自动,无需重新部署**
|
||||
|
||||
- 部署在免费、高速的 Vercel 平台
|
||||
- 支持增量式更新,更新文章后无需重复部署
|
||||
|
||||
**🚙 全功能,完全不操心**
|
||||
|
||||
- 评论、搜索、标签、分类
|
||||
- 订阅、网站统计
|
||||
- 本地化多语言
|
||||
- 服务端渲染、优秀的SEO
|
||||
|
||||
**🎨 美观,轻松自定义**
|
||||
- 丰富的配置项,更支持多语言
|
||||
- 使用 Tailwind CSS,轻松实现二次开发
|
||||
|
||||
## 特色
|
||||
- 支持更多的页面,功能,更多特性、欢迎移步[我的博客](https://tangly1024.com/article/notion-next)查看
|
||||
- 支持多主题切换
|
||||
在线演示:[https://preview.tangly1024.com/](https://preview.tangly1024.com/) ,项目支持多主题切换,没找到喜欢的主题?[贡献](/CONTRIBUTING.md)一个吧~
|
||||
|
||||
| Next | Medium | Hexo | Fukasawa |
|
||||
|--|--|--|--|
|
||||
| <img src='./docs/theme-next.png' width='300'/> [预览NEXT](https://preview.tangly1024.com/?theme=next) | <img src='./docs/theme-medium.png' width='300'/> [预览MEDIUM](https://preview.tangly1024.com/?theme=medium) | <img src='./docs/theme-hexo.png' width='300'/> [预览HEXO](https://preview.tangly1024.com/?theme=hexo) | <img src='./docs/theme-fukasawa.png' width='300'/> [预览FUKASAWA](https://preview.tangly1024.com/?theme=fukasawa) |
|
||||
|
||||
*只需修改`blog.config.js`文件的`THEME`即可实现主题切换。* 没找到喜欢的主题?[贡献](/CONTRIBUTING.md)一个吧~
|
||||
## 我要如何开始?
|
||||
|
||||
|
||||
|
||||
## 快速起步
|
||||
|
||||
- 给这个项目点个小星星 😉
|
||||
- 将 [这个 Notion 模板](https://tanghh.notion.site/02ab3b8678004aa69e9e415905ef32a5) 制作副本,并分享这个页面给所有人
|
||||
- [Fork](https://github.com/tangly1024/NotionNext/fork) 这个项目
|
||||
- _(可选)_ 用自己的图片替换 `/public` 文件夹里的 `avatar.jpg`、`favicon.svg` 和 `favicon.ico`
|
||||
- 在 `blog.config.js` 配置相关选项,`NOTION_PAGE_ID`: 你刚刚分享出去的 Notion 页面网址中的页面 ID,通常是网址中工作区地址后的 32 位字符串
|
||||
- 在 [Vercel](https://vercel.com)中部署项目
|
||||
- **稍微等等就可以访问了!** 简单吗?
|
||||
|
||||
更多项目特性及配置的说明,请移步 [NotionNext文档](https://docs.tangly1024.com/zh) 查看,文档正在完善中,欢迎 [参与编辑](https://github.com/tangly1024/nextjs-docs-notion-next)
|
||||
|
||||
## 快速开发
|
||||
- 需要安装Nodejs环境
|
||||
```bash
|
||||
yarn # 安装依赖
|
||||
yarn run dev # 本地开发
|
||||
yarn run build # 本地打包编译
|
||||
yarn run start # 本地启动NextJS服务
|
||||
```
|
||||
|
||||
## 引用技术
|
||||
|
||||
- **框架**: [Next.js](https://nextjs.org)
|
||||
- **样式**: [Tailwind CSS](https://www.tailwindcss.cn/) 和 `@tailwindcss/jit` compiler
|
||||
- **渲染**: [React-notion-x](https://github.com/NotionX/react-notion-x)
|
||||
- **评论**: [Giscus](https://giscus.app/zh-CN), [Gitalk](https://gitalk.github.io), [Cusdis](https://cusdis.com), [Utterances](https://utteranc.es)
|
||||
- **图标**:[fontawesome v5.15](https://fontawesome.com/v5.15/icons?d=gallery)
|
||||
|
||||
## 更新日志
|
||||
请移步 [更新文档](https://docs.tangly1024.com/zh/changelog)查看
|
||||
只需几分钟即可搭建您的个人站点,欢迎移步[我的博客](https://tangly1024.com/article/notion-next) 查看教程
|
||||
|
||||
|
||||
## 致谢
|
||||
@@ -120,12 +64,17 @@ yarn run start # 本地启动NextJS服务
|
||||
<td align="center"><a href="https://github.com/SwwweetOrange"><img src="https://avatars.githubusercontent.com/u/71168966" width="64px;" alt="SwwweetOrange"/><br/><sub><b>SwwweetOrange</b></sub></a><br/><a href="https://github.com/tangly1024/NotionNext/commits?author=SwwweetOrange" title="SwwweetOrange" >🔧 🐛</a></td>
|
||||
|
||||
<td align="center"><a href="https://github.com/Ylarod"><img src="https://avatars.githubusercontent.com/u/30978685" width="64px;" alt="Ylarod"/><br/><sub><b>Ylarod</b></sub></a><br/><a href="https://github.com/tangly1024/NotionNext/commits?author=Ylarod" title="Ylarod" >🔧 🐛</a></td>
|
||||
v
|
||||
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
十分期待你的[贡献](/CONTRIBUTING.md),一起来完善这个项目~
|
||||
## 引用技术
|
||||
|
||||
- **框架**: [Next.js](https://nextjs.org)
|
||||
- **样式**: [Tailwind CSS](https://www.tailwindcss.cn/) 和 `@tailwindcss/jit` compiler
|
||||
- **渲染**: [React-notion-x](https://github.com/NotionX/react-notion-x)
|
||||
- **评论**: [Giscus](https://giscus.app/zh-CN), [Gitalk](https://gitalk.github.io), [Cusdis](https://cusdis.com), [Utterances](https://utteranc.es)
|
||||
- **图标**: [Fontawesome](https://fontawesome.com/v6/icons/)
|
||||
|
||||
|
||||
## License
|
||||
|
||||
Reference in New Issue
Block a user