首页 > 代码库 > Markdown 指南

Markdown 指南

Markdown 是一种轻量级的「标记语言」,使用用特殊的 Markdown 文档处理器将 Markdown 语法翻译成预设的文档格式、标题大小等,一般用于展示时输出的是 HTML。这个教程可以让使用 Markdown 的新手快速熟悉语法和快捷键。本文基于 Ghost 的 Markdown 指南,兼容标准版 Markdown 编辑器和 Github Flavored Markdown。

NOTE: 虽然 Markdown 标记语言不能够实现 HTML 语法上的全部功能,但你可以混合使用 HTML 和 Markdown 语法。此页提供 Markdown 的简单入门指南,而 语法说明 页提供了详细的文档。

  • Markdown 指南
    • 常见格式
    • 标题
    • 文本样式
    • 图片
    • 脚注
    • 写代码
  • Examples

Markdown 指南

常用语法帮助

最常见的 Markdown 格式选项和键盘快捷键:

输出后的效果Markdown快捷键
Bold**text**Ctrl/? + B
Emphasize*text*Ctrl/? + I
Strike-through~~text~~Ctrl + Alt + U
Link[title](http://)Ctrl/? + K
Inline Code`code`Ctrl/? + Shift + K
Image![alt](http://)Ctrl/? + Shift + I
List* itemCtrl + L
Blockquote> quoteCtrl + Q
H1# Heading 
H2## HeadingCtrl/? + H
H3### HeadingCtrl/? + H (x2)

标题

标题能显示出文章的结构。行首插入 1-6 个 # ,每增加一个 # 表示更深入层次的内容,对应到标题的深度由 1-6 阶。

  • H1 : # Header 1
  • H2 : ## Header 2
  • H3 : ### Header 3
  • H4 : #### Header 4
  • H5 : ##### Header 5
  • H6 : ###### Header 6

文本样式

  • 链接 : [Title](URL)
  • 加粗 : **Bold**
  • 斜体字 : *Italics*
  • 删除线 : ~~text~~
  • 高亮 : ==text==
  • 段落 : 段落之间空一行
  • 换行符 : 一行结束时输入两个空格
  • 列表 : * 添加星号成为一个新的列表项。
  • 引用 : > 引用内容
  • 内嵌代码 : `alert(‘Hello World‘);`
  • 画水平线 (HR) : --------

图片

使用 Markdown 将图像插入文章,你需要在 Markdown 编辑器输入 ![]()。 这时在预览面板中会自动创建一个图像上传框。 技术分享 你可以从电脑桌面拖放图片 (.png, .gif, .jpg) 到上传框, 或者点击图片上传框使用标准的图像上传方式。 如果你想通过链接插入网络上已经存在的图片,只要单击图片上传框的左下角的“链接”图标,这时就会呈现图像 URL 的输入框。 技术分享 想给图片添加一个标题, 你需要做的是将标题文本插图中的方括号,e.g; ![This is a title]().

脚注

使用这样的占位符号可以将脚注添加到文本中: [^1]. 另外,你可以使用“n”而不是数字的 [^n] 所以你可以不必担心使用哪个号码。在您的文章的结尾,你可以如下图所示定义匹配的注脚,URL 将变成链接:

[^1]: This is my first footnote[^n]: Visit http://ghost.org[^n]: A final footnote

写代码

添加内嵌代码可以使用一对回勾号 `alert(‘Hello World‘)`.对于插入代码, Ghost 支持标准的 Markdown 代码和 GitHub Flavored Markdown (GFM)。标准 Markdown 基于缩进代码行或者4个空格位:

    <header>        <h1>{{title}}</h1>    </header>

GFM 使用三个回勾号 ```

´´´<header>    <h1>{{title}}</h1></header>´´´

Examples

Link Markdown Example

This is a paragraph that contains a [link to ghost](http://ghost.org).

List Markdown Example

This paragraph contains a list of items.* Item 1* Item 2* Item three

Quote Markdown Example

This paragraph has a quote> That is pulled out like thisfrom the text my post.

  • Markdown:指南
  • Markdown:语法

Markdown 指南