Skip to content

Latest commit

 

History

History
99 lines (74 loc) · 2.98 KB

README.md

File metadata and controls

99 lines (74 loc) · 2.98 KB
Raw

XuperChain 文档

基于 Sphinx 的 XuperChain 文档写作与托管平台，支持

  • 实时预览
  • 在线编辑
  • 中文搜索
  • 多版本构建
  • 访问统计
  • 自动发布
  • 标签页视图

本地编辑

安装依赖

  1. 安装依赖项

    XuperChain 文档使用 Docker 来编译 sphinx 格式的文档，生成 html，在使用前你需要 安装Docker

  2. 构建容器镜像

    make build-image

实时编辑

XuperChain 文档支持实时热更新，你可以通过浏览器进行内容实时预览

  1. 运行支持热更新的环境
    make serve
  1. 浏览器打开 http://127.0.0.1:8000 即可实时查看内容

停止服务

    make stop

清除缓存

    make clean

版本构建

  1. 构建当前版本所有内容

    构建当前版本编译当前的所有内容，生成静态 HTML 文件

    make build

  1. 构建所有版本

    文档支持多版本管理，你可以所有版本的文档。

    make release
需要注意的是，构建多版本时不会构建尚未提交的内容

更新官网

如果你已完成文档的修改，可以按照以下指导将文档的修改内容更新到 XuperChain 文档官网：

  1. 获得 Auto Publish Doc Action 触发权限
  2. Auto Publish Doc Action 中，指定目标分支执行 Run workflow
  3. 等待 Action 执行完毕，确认 XuperChain 文档官网 内容更新

若浏览器存在缓存，可能需要强制刷新目标页面，以确认内容更新

贡献指南

我们欢迎任何形式的文档贡献，包括

  1. 修改文档中的错别字
  2. 修改文档的描述，使之更加精确
  3. 修正文档中的过期内容
  4. 完善已有内容
  5. 贡献一篇全新的内容
  6. 分享使用案例

完善已有内容文档

如果你需要对 XuperChain 文档进行少量的更改，你可以直接使用在线编辑提交你的变更

  1. 浏览器打开 XuperChain 文档官网
  2. 导航到你需要修改的文档页面
  3. 点击右上角"编辑此页"按钮
  4. 修改内容后点击 "Commit Change" 提交修改

提交后会自动生成一个 Pull Request,待 Pull Request 合并后，你就可以在 XuperChain 文档官网 看到你的提交了

贡献复杂内容

如果你需要对已有文档做较多的调整，或者希望贡献一篇完整的内容，你可以

  1. 查看并签署贡献者协议
  2. 查看 贡献指南
  3. 查看 代码提交指南
  4. 本地编辑文件
  5. 提交完整的 Pull Request