ginb
v0.0.1
Published
Write & Share all in GitHub
Downloads
8
Readme
ginb
GitHub Issues Next.js Blog
介绍 Introduction
ginb (GitHub Issues Next.js Blog) 是一个基于 GitHub Issues 作为 CMS、Next.js 作为前端框架的博客模板。
ginb (GitHub Issues Next.js Blog) is a blog template that uses GitHub Issues as a CMS and Next.js as the frontend framework.
特性 Features
- [x] Dark mode
- [x] GitHub flavored markdown
- [x] Syntax highlight
- [x] KaTeX support
- [x] Labels used as tags
- [x] Metadata for SEO optimization
- [x] RSS feed
使用 Usage
- Fork 本仓库
- 修改
_config.js
文件中的sitename
和description
字段,有意绑定域名的亦需修改url
- 在 Vercel 关联你的仓库,将环境变量
GITHUB_TOKEN
设置为你的 GitHub Personal Access Token - 部署 🚀
- Fork this repository.
- Modify the
sitename
anddescription
fields in the_config.js
file. If you plan to bind a domain name, also modify theurl
. - Link your repository to Vercel and set the
GITHUB_TOKEN
environment variable to your GitHub Personal Access Token. - Deploy 🚀
更多配置请参考 Wiki。
For more configuration, please refer to the Wiki.
贡献 Contribution
欢迎各种形式的贡献,包括但不限于:主题优化,功能添加,代码改进,bug 反馈。期待你的参与!
All kinds of contributions are welcomed, including but not limited to theme optimization, feature addition, code improvement, and bug feedback. Looking forward to your participation!
TODO
- [ ] TypeScript
- [ ] Internationalization
- [ ] Search Component
- [ ] Comments in post
- [ ] Your idea...
相关项目 Related Projects
- Front-end framework: Next.js
- Front-end style: Tailwind CSS
- CMS: GitHub Issues
- Markdown content parser: react-markdown
- Syntax highlighter: rehype-highlight
- GitHub flavored markdown support: remark-gfm
- LaTeX support: remark-math and rehype-katex
- Code linter: ESLint
- Code formatter: Prettier
- Commit hook: Husky and lint-staged