安装与使用

安装

pip install zood

使用方式

初始化仓库

zood init

您可以在当前目录下得到 md-docs/ 文件夹,这里将生成和保存所有相关的md文件

其中 README.md 和 dir.yml 文件是必须保留的, README 文件默认为整个文档的初始界面

生成markdown文件

您可以使用如下命令创建一个在子目录下的文件

zood new <目录> <标题>
# zood new 快速开始 安装与使用

这里的目录是可选项,您也可以直接创建在md-docs的根目录下

zood new <标题>
# zood new 安装与使用

zood只支持一级目录,因为我认为写文档一级目录足以,多级目录没有必要

dir.yml记录了文件夹和文件的排列顺序, 默认排序为文件创建的顺序, 采用 YAML 格式

.:
- README: 1
快速开始:
- 安装与使用: 1
- 配置信息: 2
- 功能演示: 3
API:
- zood init: 1
- zood config: 2
- zood -g: 3

建议使用 zood new 创建新文件, zood会自动进行文档顺序排序.

当然您也可以手动创建文件,但是请注意您创建的文件并不会zood识别和生成,您还需要补充dir.yml中的信息以匹配文件

如果您后续修改了文件名 / 删除了文件 / 希望调整文件顺序, 这些操作都需要手动调整 dir.yml

生成网页文件

zood -g

执行此命令会在根目录下生成 docs/ , 您可以打开 doc/index.html 浏览

由于网页之间采用相对引用进行地址跳转, 所以不建议使用 file:// 协议而是本地开启一个服务器使用 https:// 协议

除此之外您可以将这个文件夹部署到 Github Page 以便浏览

20221230222949

http 服务器

zood -o

在本地会启动一个 http 服务器浏览网页

帮助文档

$ zood
zood使用方法见 https://luzhixing12345.github.io/zood/

  zood init         初始化仓库
  zood new A B      创建A目录下的B文件
  zood new A        创建根目录下的A文件
  zood update       更新dir.yml顺序
  zood -g           生成docs/目录
  zood clean        删除docs/目录
  zood config       获取配置文件
  zood -s           更新配置文件
  zood -o           启动 http 服务器

其他:
  zood poetry <choice>   更新PYPI库版本

             choice = None(default) 发布版本更新
             choice = sub           次版本更新
             choice = main          主版本更新

  zood vsce <choice>     更新Vscode扩展版本

             choice = None(default) 发布版本更新
             choice = sub           次版本更新
             choice = main          主版本更新
zood