Skip to main content
开始使用

快速开始

在睿知宝中编辑、预览并发布你的文档站点。

按照下面的步骤完成第一次模板修改和预览。

前置条件

  • 已获得一个睿知宝空间的访问权限
  • 具备编辑文档的权限
  • 发布正式版本时具备管理员权限

编辑并预览

1

进入文档空间

打开 睿知宝生产控制台,选择要维护的空间,然后进入 Editor
2

创建变更

从主分支创建一个新变更,用清晰的名称说明修改内容,例如 update-getting-started
3

修改站点配置

打开 docs.json,先修改站点名称、描述、导航栏和页脚。需要调整品牌时,再替换 /logo/favicon.svg
4

编写页面

修改 /zh/en 中的 .mdx 文件。两种语言建议保持相同的目录结构,方便长期同步维护。
5

创建预览

保存变更后触发 Preview,检查页面内容、导航、内部链接、图片、亮暗模式和语言切换。
6

发布正式版本

预览确认无误后,由管理员触发 Publish,并按页面提示完成审核和正式发布。
重命名或删除页面时,必须同步修改 docs.json 中的导航路径,否则构建会因为页面不存在而失败。

下一步

前往站点配置,了解这个模板中最常修改的配置项。
开始使用
使用指南