You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

能否用HTML编写mkdocs-material文档并生成目录等功能?

用纯HTML编写MkDocs-Material文档并生成目录的方案

核心解决思路

MkDocs默认依赖Markdown解析器,要实现纯HTML编写且生成目录,需要调整解析器配置,让系统能识别HTML标题标签的语义,同时支持HTML文件作为文档源。

具体操作步骤

  • 安装HTML标题识别扩展
    MkDocs默认解析器无法提取HTML标题生成目录,需安装python-markdown-fullhtml扩展,它能识别<h1>到<h6>标签并转换为可生成目录的结构。执行命令:

    pip install python-markdown-fullhtml
    
  • 修改MkDocs配置文件
    在mkdocs.yml中配置启用该扩展,若想直接用.html文件作为文档源,还需安装对应插件:

    # 配置Markdown扩展,识别HTML标题
    markdown_extensions:
      - fullhtml
    
    # 若要直接用.html文件作为文档,安装mkdocs-html-plugin后启用
    plugins:
      - html
    
  • 安装HTML文件支持插件
    如果不想在.md文件里写HTML,而是直接用.html文件作为文档,需安装插件扩展MkDocs的文件识别范围:

    pip install mkdocs-html-plugin
    
  • 编写纯HTML文档
    直接创建.html文件(或在.md文件中写入纯HTML),使用标准语义标签,示例:

    <h1>主标题</h1>
    <p>段落内容示例</p>
    <h2>副标题</h2>
    <p>另一段内容示例</p>
    
  • 验证效果
    运行mkdocs build或mkdocs serve,查看生成的站点侧边栏是否正确提取HTML标题生成目录。

注意事项

  • 若保留.md文件后缀,文件内尽量不要混合Markdown语法,避免解析冲突。
  • 要实现代码高亮,需给<code>标签添加对应语言类名,比如<code class="language-python">。

内容的提问来源于stack exchange,提问作者enkryptor

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.14 20:05:26