peterdavehello/npm-doctoc
peterdavehello
自动构建
Docker化的doctoc工具，用于为本地git仓库中的Markdown文件生成目录，生成的链接兼容GitHub、Bitbucket和GitLab等平台。
2 次收藏下载次数: 0状态：自动构建维护者：peterdavehello仓库类型：镜像最近更新：3 年前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
docker-doctoc
!https://img.shields.io/badge/license-GPLv3.0-brightgreen.svg?style=flat https://img.shields.io/docker/pulls/peterdavehello/npm-doctoc.svg](https://hub.docker.com/r/peterdavehello/npm-doctoc/)
https://dockeri.co/image/peterdavehello/npm-doctoc](https://hub.docker.com/r/peterdavehello/npm-doctoc/)
镜像概述
本Docker镜像封装了npm包https://github.com/thlorenz/doctoc%EF%BC%8C%E7%94%A8%E4%BA%8E%E4%B8%BA%E6%9C%AC%E5%9C%B0git%E4%BB%93%E5%BA%93%E4%B8%AD%E7%9A%84Markdown%E6%96%87%E4%BB%B6%E7%94%9F%E6%88%90%E7%9B%AE%E5%BD%95%E3%80%82%E9%80%9A%E8%BF%87%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%8F%82%E6%95%B0%EF%BC%8C%E7%94%9F%E6%88%90%E7%9A%84%E9%93%BE%E6%8E%A5%E5%85%BC%E5%AE%B9GitHub%E5%8F%8A%E5%85%B6%E4%BB%96%E5%B9%B3%E5%8F%B0%E7%9A%84%E9%94%9A%E7%82%B9%E6%A0%BC%E5%BC%8F%E3%80%82
GitHub仓库：
https://github.com/PeterDaveHello/docker-doctoc
Docker Hub仓库：
https://hub.docker.com/r/peterdavehello/npm-doctoc/
核心功能和特性
- Docker化部署：无需本地安装npm或doctoc，直接通过Docker容器运行
- 多平台兼容：生成的目录链接支持GitHub、Bitbucket、GitLab等代码托管平台
- 简单易用：通过命令行参数快速配置生成规则
- 轻量高效：基于npm包构建，镜像体积小，运行速度快
使用场景
- 为GitHub、Bitbucket或GitLab上托管的项目文档自动生成目录
- 本地Markdown文件管理，快速添加结构化目录
- 项目文档维护，确保目录与内容同步更新
使用方法
基本Docker命令
使用以下命令为指定Markdown文件生成目录：
shdocker run --rm -v "$(pwd)":/app docker.xuanyuan.run/peterdavehello/npm-doctoc doctoc /app/README.md
说明：
--rm：容器运行结束后自动删除-v "$(pwd)":/app：将当前目录挂载到容器内的/app目录doctoc /app/README.md：对挂载目录下的README.md文件执行目录生成
替换README.md为目标Markdown文件路径即可。若本地未拉取镜像，Docker会自动从Docker Hub拉取。
常用doctoc命令参数
| 参数 | 说明 |
|---|---|
--github | 生成GitHub兼容链接（默认） |
--bitbucket | 生成Bitbucket兼容链接 |
--gitlab | 生成GitLab兼容链接 |
--stdout | 将生成的目录输出到标准输出，不修改原文件 |
更多详细用法和参数说明，请访问doctoc官方主页：https://github.com/thlorenz/doctoc
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 npm-doctoc 镜像标签
docker pull docker.xuanyuan.run/peterdavehello/npm-doctoc:<标签>
DockerHub 原生拉取命令
docker pull peterdavehello/npm-doctoc:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"