%20(2).svg)
项目简介
Modoc 是一个用于创建项目文档的 HTML 静态站点生成工具。它支持用户用 Markdown 编写文档，并利用 YAML 文件进行配置，最终生成静态的 HTML 网站。该工具提供了从文档编写到网站部署的全流程支持，适用于项目文档、技术文档等场景。
项目的主要特性和功能
- Markdown 支持：使用 Markdown 编写文档，操作简单。
- YAML 配置：通过 YAML 文件进行项目配置，可灵活定制网站属性。
- 自动导航生成：依据文档目录结构自动生成导航菜单。
- 内置服务器：提供内置 HTTP 服务器，便于实时预览文档。
- 静态站点生成：生成完全静态的 HTML 网站，无需服务器端脚本。
- 自定义导航菜单：支持手动编辑导航菜单配置文件，灵活定制导航结构。
- 多平台支持：提供 Windows、Mac 和 Linux 平台的可执行程序。
安装使用步骤
1. 初始化项目
创建一个目录，在该目录下执行初始化命令：
bash
modoc init
此命令会生成 config.yaml 配置文件，用户可按需手动修改。
2. 生成导航菜单
将文档按规划放入 docs 目录下，然后执行以下命令生成导航菜单：
bash
modoc nav
该命令会根据 docs 目录结构生成 nav.yaml 文件。
3. 开启服务
执行以下命令启动内置服务器，预览文档：
bash
modoc serve
访问 http://127.0.0.1:9000 即可预览生成的网站。
4. 发布项目
执行以下命令生成静态站点：
bash
modoc build
生成的 site 文件夹可部署到任何 Web 服务器上，无需脚本环境支持。
配置说明
用户可通过编辑 config.yaml 文件定制网站的各项属性，如网站名称、端口、图标、作者等。修改配置后，重新执行 build 或 serve 命令即可应用更改。
自定义导航菜单
Modoc 会根据 docs 目录结构自动生成导航菜单。若需定制导航菜单，可手动编辑 nav.yaml 文件。注意，执行 modoc nav 命令会覆盖 nav.yaml 文件。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】