编写介绍

OpenNJet文档编写指南

OpenNJet文档采用多页HTML展示，主要由QA人员编写MD文件，利用hugo工具渲染为多页HTML，其主题采用relearning，主要利用其特有的多版本能力。

工作流

graph LR;

  管理员创建文档仓库-->拉取仓库-为每个版本创建一个站点-->创建版本化的md文档-->利用hugo本地site测试-->提交CI自动产生静态站点部署

初始目录结构

  • njet_doc
    • Readme.md
    • .gitignore
    • relearn
    • hugo.toml
    • …

从仓库check出来，文档目录顶层结构包括 relearn 目录，hugo.toml,以及已经创建的不同版本的文档，不同的版本每个用独立的目录

利用hugo 命令创建站点

  • hugo new site “{version}”
  • 链接 relearning主题到站点的themes下
  • 用上层hugo.toml替换产生的hugo.toml,
  • 删除site下的archtypes的内容，
hugo new site v1.0
cd v1.0
rm hugo.toml
ln -s ../hugo.toml hugo.toml
cd themes/
ln -s ../../relearn/ relearn

备注

依赖hugo extend 0.148 extend 及以上

hugo version
hugo v0.148.2-40c3d8233d4b123eff74725e5766fc6272f0a84d+extended linux/amd64 BuildDate=2025-07-27T12:43:24Z VendorInfo=gohugoio

安装hugo

CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@latest