教程 · AI 工具
GitHub 文档站：README 只留最短上手
把长 README 拆到文档站，保留 5 分钟上手。
前置：项目/README。
材料：Markdown、MkDocs/Docusaurus、GitHub Pages
材料：Markdown、MkDocs/Docusaurus、GitHub Pages
步骤
1. README 减法
一句话/安装/最小示例/文档链接。
2. 文档结构
快速开始/配置/API/FAQ/贡献。
3. 版本/搜索
版本选择/搜索/编辑链接。
4. 部署
GitHub Pages/自定义域；检查链接。
5. 验证
新环境按文档跑一遍。
做完检查
- README 5 分钟跑通。
- 文档有搜索/版本。
- 示例可运行。
常见错误
- README 太长。
- API 编造。
- 链接失效。
相关工具
配套模板
同类教程
提示词写了五百字还是答偏：先给角色、读者和禁区
用角色、读者、任务、结构和禁区五个槽位重写提示词，让输出稳定落在预期范围内。
查看 →AI 说得头头是道却找不到原文：要求带位置引用再回查
让模型在回答里标出原文位置和不确定项，再逐条回查，避免把模型复述当成原文依据。
查看 →长文档塞不进上下文：先分段摘要再汇总，别硬塞
把超长文档按章节拆开分段摘要，再用统一模板汇总，保证关键信息不丢且可回溯。
查看 →更新时间：2026-10-29 · 平台规则/软件版本会变；操作前保留原件，以实际页面为准。
跨库学习路径
按共同关键词匹配，不是随机推荐；从任务到提示词/教程/项目继续走。