跳到主要内容

本地维护指南

目录和端口​

项目位置/地址
平台http://localhost:13000
文档http://localhost:13001
文档源码项目根目录 docs-site/docs/
文档主题docs-site/src/css/custom.css
文档配置docs-site/docusaurus.config.js

启动与停止​

项目根目录双击 启动.cmd,或执行 start.ps1,会同时检查并启动平台与文档。停止使用 停止.cmd 或 stop.ps1。

文档也可单独通过 start-docs.ps1 与 stop-docs.ps1 管理。文档服务只绑定本机回环地址,当前不作为公网服务。

编辑和发布文档​

  1. 编辑 docs-site/docs/ 中的 Markdown 文件。
  2. 在 docs-site 运行 npm run build,检查构建和链接校验是否通过。
  3. 构建输出到 docs-site/build/;刷新页面即可看到新内容。

开发实时预览可使用 npm run dev,请先停止已占用 13001 端口的文档服务。

未来上线​

上线前更新文档站 url、首页/导航的平台链接,以及平台“文档链接”和“任务产物公开地址”。支付需要真实商户和公网回调配置,不能直接沿用本地地址。

开源说明​

平台基于 New API,并保留其项目标识、版权与许可证。文档框架为 Docusaurus。品牌显示配置不改变上游开源项目的归属与授权条件。