用 Press 把知识库变成文档站
选一个知识库,一键生成本地文档站预览,并可发布到线上。
能做什么
Press 把一个知识库生成可阅读、可搜索的文档站。你继续在知识库里写作,不需要再维护一份网站内容。
- 知识库名称就是站点名称。例如知识库叫
help,预览站点也叫help。 - 文件夹成为目录分组,Markdown 文件名成为文章名称;两边使用同一套名字。
- 正文二、三级标题生成“本页大纲”,文档间的普通 Markdown 链接会转换为站内链接。
- 保存笔记后,本地预览自动更新;线上版本需要另行确认发布。
请使用专门用于公开内容的知识库。当前版本会纳入其中全部普通 Markdown,包括 README 和带草稿标记的文档。内部反馈、工作副本和制作待办应放在这个知识库之外。
操作步骤
- 在扩展中安装并启用 Press。需要发布时,再配置 EdgeOne Pages 连接。
- 在智能体面板选中要生成站点的知识库,使用 文档站 快捷入口,或提出“为当前知识库创建文档站预览”。
- 按界面要求确认读取范围。生成完成后,打开返回的本地预览链接。
- 回到同一个知识库编辑文档并保存,在浏览器中查看更新。不要同时维护另一个同名目录副本。
- 需要更新线上版本时,明确提出“发布当前知识库的文档站”,核对确认卡中的项目、环境和内容版本,再批准发布。
标题就是文件名,改名后请检查文档间的引用。已有旧网址需要保留时,可以在文档属性中保留旧网址记录,由站点生成兼容入口。
完成后的结果
浏览器中可以按知识库目录浏览文章、搜索正文,并跳到当前文章的小标题。文章中的修改与目录变化会在下一次成功构建后出现在本地预览。
构建失败时,上一版成功预览仍可读取。只有看到本次更新成功,才把页面视为最新内容。
相关问题
- 保存后线上没变化? 保存只更新本地预览;线上更新需要明确发布并确认。
- 预览没有跟随修改? 先确认 Mindex 和预览使用的是同一个实际目录,再查看构建状态。停止预览后,需要重新创建预览。
- 草稿会公开吗? 当前版本会纳入所选知识库的全部普通 Markdown,草稿属性不等于隐藏。
- 属性和制作备注会出现在正文里吗? 属性通过文档属性查看;内部制作记录应放在公开知识库之外。代码示例中的注释仍作为示例显示。
- 如何停止预览? 在创建预览的会话中提出停止。停用 Press、撤销目录权限或关闭宿主,也会停止相应预览。