飞翔飞翔
主页
  • 计算机基础

    • TCP协议
  • 数据库

    • SQL教程
  • 编程语言

    • C语言
    • Python2
    • Python3
  • 数据格式

    • JSON教程
  • 工具

    • Markdown指南
  • Git

    • GitFlow
  • Quartz

    • Quartz教程
  • Java

    • Java设计模式
  • 缓存

    • Redis教程
联系
阿里云
主页
  • 计算机基础

    • TCP协议
  • 数据库

    • SQL教程
  • 编程语言

    • C语言
    • Python2
    • Python3
  • 数据格式

    • JSON教程
  • 工具

    • Markdown指南
  • Git

    • GitFlow
  • Quartz

    • Quartz教程
  • Java

    • Java设计模式
  • 缓存

    • Redis教程
联系
阿里云
  • 入门指南
  • 速查表
  • 基本语法

    • 标题
    • 段落
    • 换行
    • 强调
    • 引用块
    • 列表
    • 代码
    • 水平线
    • 链接
    • 图片
    • 转义字符
    • HTML
  • 扩展语法

    • 可用性
    • 表格
    • 围栏代码块
    • 脚注
    • 标题ID
    • 定义列表
    • 删除线
    • 任务列表
    • 表情符号
    • 高亮
    • 下标
    • 上标
    • 自动URL链接
    • 禁用自动URL链接
  • 实用技巧

    • 概述
    • 下划线
    • 缩进
    • 居中
    • 颜色
    • 注释
    • 提示框
    • 图片大小
    • 图片说明
    • 链接目标
    • 符号
    • 表格格式
    • 目录
    • 视频
  • 工具
  • 版权声明

MkDocs

MkDocs

MkDocs 是一个专为构建文档网站而设计的静态站点生成器。其使用 Python 编写,是一个拥有大量社区支持的开源项目。提供了多种可用的主题。在 Markdown 支持方面,MkDocs 对基本语法元素的支持非常出色,但缺少一些扩展语法元素的支持。

该应用使用 Python-Markdown 作为 Markdown 处理器。你可以启用额外的扩展。

新部署的 MkDocs 网站

MkDocs Markdown 支持

MkDocs 支持以下 Markdown 元素。

功能支持备注
标题是
段落是
换行是
粗体是
斜体是
引用块是
有序列表是
无序列表是
代码是
水平线是
链接是
图片是
表格是
围栏代码块是
语法高亮是
脚注否
标题 ID否
定义列表否
删除线否
任务列表否
表情符号(复制粘贴)未知
表情符号(短代码)未知
高亮否
下标否
上标否
自动 URL 链接是
禁用自动 URL 链接是
HTML是

使用警告

这是一个实用的功能:你可以启用一个扩展来在 MkDocs 中使用警告。这是一种在 MkDocs 网站上快速使用备注、警告和提示的方式。有关更多信息和示例,请参见此 GitHub 问题。

另见

  • 在 MkDocs 中使用 Markdown 编写
  • MkDocs GitHub 仓库