{"id":23357498,"url":"https://github.com/cs-magic-open/md-toc","last_synced_at":"2025-07-27T16:08:02.013Z","repository":{"id":267078985,"uuid":"900210018","full_name":"cs-magic-open/md-toc","owner":"cs-magic-open","description":"一个强大的 Markdown 目录生成器，基于 md-toc 并提供了显著增强，包括完整的中文支持、多种目录样式和丰富的自定义选项。","archived":false,"fork":false,"pushed_at":"2024-12-08T07:36:05.000Z","size":142,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-20T12:05:28.688Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@cs-magic/md-toc","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cs-magic-open.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-08T06:49:26.000Z","updated_at":"2024-12-12T13:56:47.000Z","dependencies_parsed_at":"2024-12-12T23:57:31.874Z","dependency_job_id":null,"html_url":"https://github.com/cs-magic-open/md-toc","commit_stats":null,"previous_names":["cs-magic/markdown-toc-gen","cs-magic-open/md-toc"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cs-magic-open/md-toc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cs-magic-open%2Fmd-toc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cs-magic-open%2Fmd-toc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cs-magic-open%2Fmd-toc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cs-magic-open%2Fmd-toc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cs-magic-open","download_url":"https://codeload.github.com/cs-magic-open/md-toc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cs-magic-open%2Fmd-toc/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267383741,"owners_count":24078571,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-27T02:00:11.917Z","response_time":82,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-21T10:29:17.453Z","updated_at":"2025-07-27T16:08:01.962Z","avatar_url":"https://github.com/cs-magic-open.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# md-toc\n\n\u003c!-- toc --\u003e\n\n[md-toc](#md-toc) • [为什么选择 md-toc？](#为什么选择-md-toc) • [安装](#安装) • [快速开始](#快速开始) • [进阶使用](#进阶使用) • [配置选项](#配置选项) • [常见问题](#常见问题) • [贡献指南](#贡献指南) • [License](#license) • [致谢](#致谢)\n\n\u003c!-- tocstop --\u003e\n\n一个强大的 Markdown 目录生成器，基于 md-toc 并提供了显著增强，包括完整的中文支持、多种目录样式和丰富的自定义选项。\n\n## 为什么选择 md-toc？\n\n- 🀄️ **完整的中文支持** - 完美支持中文标题和链接\n- 🎯 **多样化的目录样式** - 支持横向（适合简短目录）和纵向（适合详细目录）两种风格\n- ⚡️ **批量处理能力** - 轻松处理多个文档，支持 glob 模式匹配\n- 🔄 **实时监听** - 支持文件变化自动更新，完美集成到你的写作流程\n- 🎨 **高度可定制** - 灵活的配置选项，包括目录深度、样式和标记\n- 📦 **多种使用方式** - 支持命令行、配置文件和 API 调用，满足不同场景需求\n- 🚀 **专业的日志系统** - 提供详细的调试信息，让问题排查更轻松\n\n## 安装\n\n```bash\nnpm install -g @cs-magic/md-toc\n# 或\nyarn global add @cs-magic/md-toc\n# 或\npnpm add -g @cs-magic/md-toc\n```\n\n## 快速开始\n\n1. 在你的 Markdown 文件中添加目录标记：\n\n```markdown\n\u003c!-- toc --\u003e\n\u003c!-- tocstop --\u003e\n```\n\n2. 运行命令生成目录：\n\n```bash\nmd-toc README.md\n```\n\n就是这么简单！\n\n## 进阶使用\n\n### 命令行选项\n\n```bash\n# 自动插入目录标记（如果文件中没有）\nmd-toc README.md --auto-insert\n\n# 使用横向样式（适合简短目录）\nmd-toc README.md --style horizontal\n\n# 设置最大标题层级\nmd-toc README.md --max-level 3\n\n# 监听文件变化\nmd-toc README.md --watch\n\n# 设置日志级别（debug, info, warn, error）\nmd-toc README.md --log-level debug\n\n# 处理多个文件\nmd-toc doc1.md doc2.md\n\n# 使用 glob 模式\nmd-toc \"docs/*.md\"\n```\n\n### 配置文件\n\n创建 `.tocrc.json` 或 `.tocrc.js` 文件：\n\n```json\n{\n  \"files\": [\"README.md\", \"docs/*.md\"],\n  \"style\": \"horizontal\",\n  \"autoInsert\": true,\n  \"maxLevel\": 2,\n  \"watch\": false,\n  \"logLevel\": \"info\"\n}\n```\n\n### API 使用\n\n```typescript\nimport { generateToc } from \"md-toc\";\n\n// 生成目录\nawait generateToc(\"README.md\", {\n  style: \"horizontal\",\n  autoInsert: true,\n  maxLevel: 2,\n});\n\n// 批量处理\nawait generateToc([\"doc1.md\", \"doc2.md\"], {\n  style: \"vertical\",\n});\n\n// 使用 glob 模式\nawait generateToc(\"docs/*.md\", {\n  watch: true,\n});\n```\n\n## 配置选项\n\n| 选项         | 说明             | 默认值     | 描述                                       |\n| ------------ | ---------------- | ---------- | ------------------------------------------ |\n| `style`      | 目录样式         | `vertical` | `horizontal`（横向）或 `vertical`（纵向）  |\n| `autoInsert` | 自动插入目录标记 | `false`    | 当文件中没有目录标记时自动插入             |\n| `minLevel`   | 最小标题层级     | `2`        | 控制目录中包含的标题层级                   |\n| `maxLevel`   | 最大标题层级     | `2`        | 控制目录中包含的标题层级                   |\n| `watch`      | 监听文件变化     | `false`    | 当文件变化时自动更新目录                   |\n| `logLevel`   | 日志级别         | `info`     | `error`/`warn`/`info`/`debug` 控制日志输出 |\n| `markers`    | 自定义目录标记   | 见下文     | 自定义目录的开始和结束标记                 |\n\n### 目录标记\n\n默认的目录标记：\n\n```markdown\n\u003c!-- toc --\u003e\n\n目录将在这里生成\n\n\u003c!-- tocstop --\u003e\n```\n\n也支持单行格式：\n\n```markdown\n\u003c!-- toc --\u003e\u003c!-- tocstop --\u003e\n```\n\n如果你想在文档中展示目录标记而不让它被处理，需要在标记前添加反斜杠：\n\n```markdown\n\\\u003c!-- toc --\u003e\n```\n\n## 常见问题\n\n### 为什么选择 md-toc 而不是 markdown-toc？\n\nmd-toc 是基于 markdown-toc 开发的增强版本，主要解决了以下问题：\n\n1. **中文支持** - markdown-toc 在处理中文标题时存在问题，而 md-toc 完美支持中文\n2. **更多功能** - 提供了更丰富的功能，如多种目录样式、文件监听、详细的日志等\n3. **更好的开发体验** - 提供了更友好的 API 和配置选项，支持 TypeScript\n\n### 目录链接不起作用？\n\n确保你的标题符合 Markdown 规范，不包含特殊字符。如果仍有问题，可以尝试使用 `--log-level debug` 查看详细日志。\n\n## 贡献指南\n\n欢迎提交 Issue 和 Pull Request！在贡献代码前，请先阅读我们的[贡献指南](CONTRIBUTING.md)。\n\n## License\n\nMIT\n\n## 致谢\n\n- [markdown-toc](https://github.com/jonschlinkert/markdown-toc) - 本项目参考\n- [chalk](https://github.com/chalk/chalk) - 终端样式库\n- 所有贡献者和用户 ❤️\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcs-magic-open%2Fmd-toc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcs-magic-open%2Fmd-toc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcs-magic-open%2Fmd-toc/lists"}