Docker：一款强大的文档生成工具

Docker：一款强大的文档生成工具

dockerDocumentation generator项目地址:https://gitcode.com/gh_mirrors/docker22/docker

Docker 是一个基于 Docco 和 Docco-Husky 的增强型文档生成器，专为处理大型项目中的数百个脚本文件而设计。它的出现是为了弥补原有工具在处理大规模项目时的不足。你可以访问这个项目的公共页面来亲身体验一下它所能实现的效果。

安装与使用

Docker 的安装非常简单，只需一条命令：

npm install -g docker

要使用 Docker，你可以执行以下命令：

docker [选项] [文件...]

可用的选项包括：

• -i, --input_dir: 输入源代码目录，默认为当前目录。
• -o, --output_dir: 输出文档目录，默认为 ./doc。
• -u, --updated_files: 如果设置，则只处理已更新的文件。
• -c, --colour_scheme: 使用的颜色方案。
• -I, --ignore_hidden: 忽略以点或下划线开头的文件和目录。
• -w, --watch: 保持进程运行，监视目录变动，并自动更新文件。
• -s, --sidebar: 是否默认开启侧边栏（默认开启，可选值：yes, no, true, false）。值 disable 将完全禁用侧边栏。
• -x, --exclude: 以逗号分隔的排除路径列表，支持基本通配符 *。
• -n, --line_number: 是否在输出中包含行号（默认关闭）。
• -m, --multi_line_only: 是否仅处理多行注释（默认关闭）。
• --js: 指定额外的 JavaScript 文件（相对于当前目录）。
• --css: 类似于 --js 但用于 CSS 文件。
• --extras: 要激活的可选附加功能（见下方）。

如果没有指定文件列表，Docker 将遍历当前目录下的所有文件。

示例

如果你没有全局安装 Docker，请将 docker 替换为类似 $(npm root)/docker/docker 的路径。

处理当前目录的所有文件到 "doc"

$ docker

将 "src" 中的文件处理到 "documents"

$ docker -i src -o documents

或者：

$ docker -o documents src

或者：

$ docker -o documents src/*

注意，第一个示例中，src 目录的内容将直接映射到 documents，而在第二个和第三个示例中，文件将在 documents/src 内创建。

附加功能

为了使 Docker 的输出保持简洁，一些高级特性如文件搜索和行跳转被独立封装为单独的文件，可以通过特定标志启用。查看项目的extras目录了解更多详情。

颜色方案

Docker 支持 highlight.js 的所有样式。你可以参考 highlight.js 演示 来选择颜色方案，并使用对应的 CSS 文件名作为选项值。

注意事项

所有文件需位于输入目录（通过 -i 指定）或其子目录内，否则输出文件的路径可能不正确，甚至可能导致无限循环的问题。

Docker 的设计目的是简化且强大，它能够有效地帮助开发者管理和呈现源代码的文档，对于任何规模的项目都是一个值得信赖的助手。立即尝试并体验 Docker 带来的高效能文档生成吧！

dockerDocumentation generator项目地址:https://gitcode.com/gh_mirrors/docker22/docker