配置信息

如果您想修改zood的默认配置,你需要首先调出zood的配置文件

zood config

接下来您可以修改 md-docs/ 下生成的 _config.yml 文件.md-docs目录下的config文件的优先级要高于全局config配置

您可_config.yml的配置选项的命名及其注释自行修改

此时您的目录结构应该如下所示

- md-docs/
  - README.md
  - dir.yml
  - _config.yml

修改完成后如果您想永久保存修改需要将其重新注册回zood,注意此操作为替换操作,您所做的修改将成为全局配置文件并应用于之后所有的项目

zood -s

如果不想修改内容作用于全局则不要使用zood -s

可配置选项

配置内容总共分为如下几个部分

• options: 相关功能的启用/关闭
  • 启用dark主题
  • 复制代码
  • 代码高亮
  • 上一个/下一个
  • 图片放大预览
  • 开启github图标
  • 启用目录导航栏
  • 支持 mermaid(默认不开启)
  • 保留图片的标题(默认不开启)

• position: 页面布局选项,用于调整页面中元素位置,大小

• color: 各种颜色选项

• font: 字体

github 默认使用 git 来获取当前仓库的 origin 的 url 作为地址链接