Dokki Docs logo

公共站点

公共站点将选定的 Dokki 资源转换为可浏览的网站。可用于产品文档、公共指南、知识库、报告及其他经批准的信息。

创建站点

  • 打开 工作区 → 扩展 → 发布

  • 选择站点地址并启用站点。

  • 发布访客应能打开的资源。

  • 在未登录的窗口中打开公共地址并查看站点。

组织访客体验

使用 外观 选择主页行为并添加基于标签的导航。使用 内容 控制哪些资源可用。使用 站点设置 管理地址、列表、语言和自定义域名。

已列出和未列出的站点

  • 已列出 的站点可以出现在受支持的发现界面中,例如站点的站点地图。

  • 未列出 的站点仍可由拥有其直接链接的人打开,但会被排除在正常的发现和搜索索引信号之外。

当访问权限必须限于指定人员时,请使用工作区或资源共享,而不是未列出的公共站点。

保持站点最新

当已发布的资源发生变化时,其状态变为 已更新。查看更改并提交新的公共版本。如果状态为 未知,请在发布前重试,以免基于不完整的信息进行操作。

语言和域名

站点设置可以提供额外的公共语言并连接自定义域名。先配置默认站点,然后添加这些选项并从访客的角度进行验证。

将已发布的 Markdown 镜像到 GitHub

站点设置 → GitHub 同步 中,连接 GitHub,选择仓库、分支
和可选的基础路径,然后保存,再选择 立即同步。当工作区的计划允许站点时,工作区
编辑者和管理员可以运行同步。也可以为后续发布的更新启用自动同步。

Dokki 会生成一个 README.md 索引,并为每个当前
已发布的资源生成一个 Markdown 文件。这些文件遵循已发布的资源树,并包含
规范的源元数据以及 generated_by: Dokki。同步会更新已更改的
生成文件,保持相同的文件不变,并且仅当过时的 Markdown 带有该生成标记时才将其删除;无关的仓库文件不属于
清理范围。

GitHub 仓库是冻结的已发布内容的镜像,而不是编辑
源。在 Dokki 中编辑并发布,然后再次同步。对生成的
Markdown 的直接编辑可能会被后续同步覆盖。

分享站点之前

  • 检查每个导航项和重要链接。

  • 在桌面端和窄屏上查看站点。

  • 确认不包含任何私人姓名、评论、凭据或草稿内容。

  • 每次重要更新后再次检查公共页面。