mobile wallpaper 1mobile wallpaper 2mobile wallpaper 3mobile wallpaper 4
698 字
2 分钟
Markdown 教程
2025-01-20

Markdown 教程#

本文是 Markdown 写作示例,整合了常用语法与扩展语法(GFM)。

块级元素#

段落与换行#

段落#

HTML 标签:<p>

使用一个或多个空行来分隔段落。(只包含空格或制表符的行也算空行。)

代码:

This will be
inline.
This is second paragraph.

预览:


This will be inline.

This is second paragraph.


换行#

HTML 标签:<br />

在行尾添加两个或更多空格即可换行。

代码:

This will be not
inline.

预览:


This will be not
inline.


标题#

Markdown 支持 Setext 与 atx 两种标题写法。

Setext#

HTML 标签:<h1><h2>

使用等号 (=) 表示 <h1>,使用减号 (-) 表示 <h2>,数量不限。

atx#

HTML 标签:<h1> ~ <h6>

使用 1~6 个 # 作为标题层级。也可以在末尾补 # 关闭标题,数量不必完全一致。

引用#

HTML 标签:<blockquote>

使用 > 创建引用块,可嵌套,也可包含标题、列表、代码块等其他 Markdown 元素。

列表#

Markdown 支持无序列表与有序列表。

  • 无序列表可用 *+-
  • 有序列表使用 1. 2. 这样的格式
  • 列表项中可嵌套引用、代码块、子列表

代码块#

HTML 标签:<pre>

  • 缩进 4 个空格或 1 个 Tab 可创建代码块
  • 推荐使用围栏代码块(```)
  • 可指定语言以启用语法高亮
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html

分隔线#

HTML 标签:<hr />

单独一行中使用三个或以上的 -*_ 即可。

表格#

HTML 标签:<table>

表格是扩展语法,使用 | 分隔列、使用 - 分隔表头,使用 : 控制对齐。

左对齐居中右对齐
aaabbbccc
dddeeefff

行内元素#

链接#

HTML 标签:<a>

支持两种写法:

  1. 行内链接:[文本](URL "标题")
  2. 引用链接:先定义 [id]: URL "标题",再用 [文本][id]

相对路径也可用于站内链接,例如:[关于](/about/)

强调#

HTML 标签:<em><strong>

  • *文本*_文本_:斜体
  • **文本**__文本__:粗体

行内代码#

HTML 标签:<code>

使用反引号包裹,例如:printf()

图片#

HTML 标签:<img />

语法与链接类似:

  • 行内:![说明](URL "标题")
  • 引用:![说明][id]

删除线#

HTML 标签:<del>

GFM 支持 ~~删除线~~

其他语法#

自动链接#

使用尖括号可快速生成链接:

  • <http://example.com/>
  • <address@example.com>

反斜杠转义#

使用 \ 可转义 Markdown 特殊符号,例如:\*literal asterisks\*

行内 HTML#

Markdown 无法覆盖的场景可直接写 HTML。

  • 块级 HTML 标签内部通常不会再解析 Markdown 语法
  • 行内 HTML 标签中一般仍会解析 Markdown

通过以上语法,你可以完成绝大多数技术博客写作需求。

分享

如果这篇文章对你有帮助,欢迎分享给更多人!

Markdown 教程
https://github.com/emn178/markdown
作者
emn178
发布于
2025-01-20
许可协议
Unlicensed

部分信息可能已经过时

目录