SuperAPI AI 工具集

markdown-content-formatter

办公与效率

查看项目

更新于 10-16 08:36

技能介绍

用途:面向文档、博客和静态站点生成器的长文 Markdown 内容,进行结构化、校验与格式化。

主要能力:自动生成目录(可设深度与样式);添加 YAML/TOML/JSON frontmatter;校验标题层级跳级、失效链接、重复标题、缺失 ID 等结构问题;为代码块补语言标记并把缩进代码转为围栏代码;自动生成标题锚点与交叉引用;统一空行与列表间距;在 GitHub、CommonMark、Jekyll、Hugo 风格间转换;支持导出与批量处理。

使用方式:Python 中导入 MarkdownFormatter,用 file_path 或 content 初始化,调用 generate_toc、validate_structure、add_frontmatter、export 等方法。命令行示例:python scripts/markdown_formatter.py --input document.md --toc --toc-depth 3 --toc-style github --output formatted.md;校验用 --validate --format json。依赖 markdown>=3.5.0、pyyaml>=6.0.0、beautifulsoup4>=4.12.0、pandas>=2.0.0,安装命令 pip install -r scripts/requirements.txt。

适用场景:文档站、博客、静态站点生成器的内容整理与发布前检查。

限制:默认不发起网络请求校验外链;解析基于 Python-Markdown,边缘情况可能与其他解析器不同;并非所有风格特性都能转换(如 Hugo shortcodes);锚点按 GitHub 算法生成;代码语言自动识别有限;超大文件(>10MB)可能较慢;部分 Unicode 锚点、复杂嵌套列表、原始 HTML、LaTeX 公式可能不被完美处理或校验。