Introduction
Welcome to GitBook Online Generator — a GitHub-native system that transforms structured Markdown folders into beautiful, static online books.
What is this?
This project allows you to:
- Write content in Markdown
- Organize it with folders and files
- Push to GitHub and automatically publish a static book website
No backend, no database, no CMS — just Markdown and GitHub.
为什么选择这个工具？
这个工具专为技术写作者、工程师和教育工作者设计。它遵循以下核心原则：
- 文件夹即结构 — 目录层级定义书籍章节
- 文件名即顺序 — 数字前缀控制排列顺序
- Markdown 即真理 — 所有内容都用 Markdown 编写
- 静态优先 — 输出纯静态 HTML/CSS/JS
- GitHub 原生 — 通过 GitHub Actions 自动构建
Key Features
| Feature | Description |
|---|---|
| Folder-based structure | Directories become chapters |
| Auto-sorted content | Numeric prefixes control order |
| Multilingual support | Full UTF-8 for all languages |
| Responsive design | Looks great on any device |
| Theme switching | Default, Dark, Light, Sepia |
| Mermaid diagrams | Client-side diagram rendering |
| Zero backend | Pure static output |
How It Works
graph LR
A[Write Markdown] --> B[Push to GitHub]
B --> C[GitHub Actions Build]
C --> D[Static HTML Output]
D --> E[Published Website]
Tip: Use the theme switcher in the top-right corner to try different reading modes!