forge doc
名称
forge-doc - 为 Solidity 源文件生成文档。
概要
forge doc [选项]
描述
从 Solidity 源文件生成并构建 mdbook。
选项
--root 路径
项目的根路径。默认情况下，这是当前 git 存储库的根目录，或当前工作目录。
--out 路径
生成的 mdbook 的输出路径。默认情况下，它是项目根目录中的 docs/。
--build
从生成的文件构建 mdbook。
--serve
在本地提供文档。
--hostname 主机名
用于提供文档的主机名。需要 --serve。
--port 端口
用于提供文档的端口。需要 --serve。
普通选项
-h
--help
打印帮助信息。
示例
- 生成文档。
forge doc - 生成并构建具有指定输出目录的文档。
forge doc --build --out ./documentation - 在本地生成并提供文档，端口为 4000。
forge doc --serve --port 4000