快速开始
快速开始
这份文档站一共只有 10 个文件,看懂这篇,你就能完全掌握它。
一句话原理
文档就是你服务器上的
.md文件,目录层级就是侧边栏层级。
没有数据库、没有构建步骤、没有后台服务。你放一个文件进去,侧边栏就多一个条目。
五个入口
| 想做什么 | 去哪里 |
|---|---|
| 看文档 | 网站首页 → 左侧目录点开 |
| 写文档 | 网站顶部「写作」→ /admin/index.php |
| 搜内容 | 顶部搜索框,或按 Ctrl + K |
| 玩点东西 | 网站顶部「玩法」→ /play/ |
| 用工具 | 网站顶部「工具」→ /tools/ |
玩法和工具中心
站点里除了文档,还有两个纯前端的板块,不用登录、不连数据库、断网也能用:
- 🎮 玩法中心
/play/—— 电脑钢琴、鼓机、像素画板、算法可视化动画、怀旧小游戏合集 - 🧰 工具中心
/tools/—— 开发工具箱、打字测速、二维码生成器、番茄钟 + 白噪音
每个玩法/工具在文档里都有一篇说明,见左侧目录的「玩法中心」和「工具中心」两个分类。 (顶部搜索框只搜 .md 文档,所以想找玩法说明就在文档里搜。)
写一篇新文档(最快路径)
- 打开
/admin/index.php,输入密码登录 - 点左下角「+ 新建文档」
- 输入路径,比如
cpp/suanfa/erfen.md(目录不存在会自动建) - 在编辑器里写,写完点「💾 保存发布」
- 刷新前台,左侧目录里立刻出现
目录层级是怎么来的
docs/
├── cpp/ ← 大分类:C++
│ ├── jichu/ ← 小分类:基础
│ │ └── zhizhen.md ← 文档:指针与引用
│ └── suanfa/ ← 小分类:算法
│ └── dp.md
├── play/ ← 大分类:玩法中心说明
│ ├── 00-玩法中心.md
│ └── 01-电脑钢琴.md …
├── tools/ ← 大分类:工具中心说明
│ ├── 00-工具中心.md
│ └── 01-开发工具箱.md …
└── guide/ ← 大分类:使用教程(你现在看的这里)
└── 01-快速开始.md
想加几级就建几层文件夹,侧边栏自动跟着变。
侧边栏显示的名字从哪来
取文档第一行 # 标题。 所以文件名可以叫 01-kuaisukaishi.md(好排序),显示出来却是「快速开始」。
建议用数字前缀命名,比如 01-、02-,这样侧边栏顺序可控。
顶部五个按钮
- 首页 —— 渐变欢迎页 + 全部文档入口
- 文档 —— 文档中心总览(还没选文章时的样子)
- 玩法 —— 五个可以直接玩的小东西
- 工具 —— 四个随手能用的在线工具
- 写作 —— 直接进后台编辑器
快捷键
| 快捷键 | 作用 |
|---|---|
Ctrl + K |
聚焦搜索框 |
| 输入关键词 | 实时出结果,标题命中的排前面 |
搜索是全文搜索,正文里的内容也能搜到,不只是标题。
jhp.studio