如何预览MkDocs-macros构建中HTML渲染前的Markdown中间内容?
Markdown 格式化指南
以下是各类内容的Markdown格式化规则及示例:
标题:使用数字符号(
#),数量对应标题层级,最多支持6级:# 一级标题 ## 二级标题 ### 三级标题 #### 四级标题列表项:以短横线(
-)开头,嵌套列表需缩进:- 主列表项1 - 主列表项2 - 子列表项1 - 子列表项2强调文本:用单个星号(
*)包裹实现斜体强调:*这是被强调的斜体文本*效果:这是被强调的斜体文本
代码或命令:单行内容用单个反引号(
`)包裹,多行代码用三个反引号包裹,还可指定语言语法高亮:
单行示例:`npm install mkdocs-macros`多行示例:
def debug_markdown(content): with open("debug.md", "w", encoding="utf-8") as f: f.write(content)引用文本:使用大于号(
>),多层引用可叠加多个大于号:> 一级引用文本 >> 二级嵌套引用文本效果:
一级引用文本
二级嵌套引用文本
链接:显示文本用方括号(
[])包裹,目标URL用圆括号(())紧跟其后:[MkDocs 官方文档](https://www.mkdocs.org)效果:MkDocs 官方文档
图片:图片替代文本用方括号(
[])包裹,图片URL用圆括号(())紧跟其后,开头需加感叹号:[MkDocs 图标](https://www.mkdocs.org/img/favicon.ico)效果:
内容的提问来源于stack exchange,提问作者Nick J
相关产品推荐
相关产品推荐

