Orihon (经折,Traditional Chinese: 經摺)
A Unofficial Cbeta Staticization Project.
Features
- 📚 Pure static, All documents are hosted on the CDN via server rendering. So, it's really fast.
- 📦 Out of the Box, Orihon has build-in cbeta documents and font rendering. No additional content needs to be downloaded.
- 🚀 Self hosted supported. Supporting 1-click-hosting on vercel.
Run Local
Create .env.local
at root directory of repository:
ALGOLIA_APP_ID="{{YOUR ALGOLIA APP ID}}"
ALGOLIA_CLIENT_KEY="{{YOUR ALGOLIA QUERY KEY}}"
Then run yarn dev
, open http://localhost:3000/
.
Self-hosted Guide
Enviroment Variables
process.env.GITHUB_ACCESS_TOKEN
Github Access Token to read github repo contentsprocess.env.ALGOLIA_APP_ID
Algolia Application ID to implements search.process.env.ALGOLIA_ADMIN_KEY
Algolia Admin API Key to add Algolia index.
Special Thanks to
(In chronological order)
- cbeta-org / xml-p5 for datasources maintaining.
- 赫蹏(hètí) for the great inspiration.