Markdown 教程

作者: zjfclimin | 来源:发表于2017-04-19 10:41 被阅读137次

Cmd Markdown 简明语法手册

标签： Cmd-Markdown

1. 斜体和粗体

使用 * 和 ** 表示斜体和粗体。

示例：

这是斜体，这是粗体。

2. 分级标题

使用 === 表示一级标题，使用 --- 表示二级标题。

示例：

这是一个一级标题
============================

这是一个二级标题
--------------------------------------------------

### 这是一个三级标题

你也可以选择在行首加井号表示不同级别的标题 (H1-H6)，例如：# H1, ## H2, ### H3，#### H4。

3. 外链接

使用 [描述](链接地址) 为文字增加外链接。

示例：

这是去往本人博客的链接。

4. 无序列表

使用 *，+，- 表示无序列表。

示例：

无序列表项一
无序列表项二
无序列表项三

5. 有序列表

使用数字和点表示有序列表。

示例：

有序列表项一
有序列表项二
有序列表项三

6. 文字引用

使用 > 表示文字引用。

示例：

野火烧不尽，春风吹又生。

7. 行内代码块

使用 `代码` 表示行内代码块。

示例：

让我们聊聊 html。

8. 代码块

使用四个缩进空格表示代码块。

示例：

这是一个代码块，此行左侧有四个不可见的空格。

9. 插入图像

使用 ![描述](图片链接地址) 插入图像。

示例：

我的头像

Cmd Markdown 高阶语法手册

1. 内容目录

在段落中填写 [TOC] 以显示全文内容的目录结构。

[TOC]

2. 标签分类

在编辑区任意行的列首位置输入以下代码给文稿标签：

标签：数学英语 Markdown

或者

Tags：数学英语 Markdown

3. 删除线

使用 ~~ 表示删除线。

~~这是一段错误的文本。~~

4. 注脚

使用 [^keyword] 表示注脚。

这是一个注脚^[1]的样例。

这是第二个注脚^[2]的样例。

5. LaTeX 公式

$ 表示行内公式：

质能守恒方程可以用一个很简洁的方程式 $E=mc^2$ 来表达。

$$ 表示整行公式：

$$\sum_{i=1}^n a_i=0$$

$$f(x_1,x_x,\ldots,x_n) = x_1^2 + x_2^2 + \cdots + x_n^2 $$

$$\sum^{j-1}{k=0}{\widehat{\gamma}{kj} z_k}$$

访问 MathJax 参考更多使用方法。

6. 加强的代码块

支持四十一种编程语言的语法高亮的显示，行号显示。

非代码示例：

$ sudo apt-get install vim-gnome

Python 示例：

@requires_authorization
def somefunc(param1='', param2=0):
    '''A docstring'''
    if param1 > param2: # interesting
        print 'Greater'
    return (param2 - param1 + 1) or None

class SomeClass:
    pass

>>> message = '''interpreter
... prompt'''

JavaScript 示例：

/**
* nth element in the fibonacci series.
* @param n >= 0
* @return the nth element, >= 0.
*/
function fib(n) {
  var a = 1, b = 1;
  var tmp;
  while (--n >= 0) {
    tmp = a;
    a += b;
    b = tmp;
  }
  return a;
}

document.write(fib(10));

7. 流程图

示例

st=>start: Start:>https://www.zybuluo.com
io=>inputoutput: verification
op=>operation: Your Operation
cond=>condition: Yes or No?
sub=>subroutine: Your Subroutine
e=>end

st->io->op->cond
cond(yes)->e
cond(no)->sub->io

更多语法参考：流程图语法参考

8. 序列图

示例 1

Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!

示例 2

Title: Here is a title
A->B: Normal line
B-->C: Dashed line
C->>D: Open arrow
D-->>A: Dashed open arrow

更多语法参考：序列图语法参考

9. 甘特图

甘特图内在思想简单。基本是一条线条图，横轴表示时间，纵轴表示活动（项目），线条表示在整个期间上计划和实际的活动完成情况。它直观地表明任务计划在什么时候进行，及实际进展与计划要求的对比。

    title 项目开发流程
    section 项目确定
        需求分析       :a1, 2016-06-22, 3d
        可行性报告     :after a1, 5d
        概念验证       : 5d
    section 项目实施
        概要设计      :2016-07-05  , 5d
        详细设计      :2016-07-08, 10d
        编码          :2016-07-15, 10d
        测试          :2016-07-22, 5d
    section 发布验收
        发布: 2d
        验收: 3d

更多语法参考：甘特图语法参考

10. Mermaid 流程图

    A[Hard edge] -->|Link text| B(Round edge)
    B --> C{Decision}
    C -->|One| D[Result one]
    C -->|Two| E[Result two]

更多语法参考：Mermaid 流程图语法参考

11. Mermaid 序列图

    Alice->John: Hello John, how are you?
    loop every minute
        John-->Alice: Great!
    end

更多语法参考：Mermaid 序列图语法参考

12. 表格支持

项目	价格	数量
计算机	$1600	5
手机	$12	12
管线	$1	234

13. 定义型列表

名词 1
: 定义 1（左侧有一个可见的冒号和四个不可见的空格）

代码块 2
: 这是代码块的定义（左侧有一个可见的冒号和四个不可见的空格）

    代码块（左侧有八个不可见的空格）

14. Html 标签

本站支持在 Markdown 语法中嵌套 Html 标签，譬如，你可以用 Html 写一个纵跨两行的表格：

<table>
    <tr>
        <th rowspan="2">值班人员</th>
        <th>星期一</th>
        <th>星期二</th>
        <th>星期三</th>
    </tr>
    <tr>
        <td>李强</td>
        <td>张明</td>
        <td>王平</td>
    </tr>
</table>

15. 内嵌图标

本站的图标系统对外开放，在文档中输入

<i class="icon-weibo"></i>

即显示微博的图标： <i class="icon-weibo icon-2x"></i>

替换上述 i 标签 内的 icon-weibo 以显示不同的图标，例如：

<i class="icon-renren"></i>

即显示人人的图标： <i class="icon-renren icon-2x"></i>

更多的图标和玩法可以参看 font-awesome 官方网站。

16. 待办事宜 Todo 列表

使用带有 [ ] 或 [x] （未完成或已完成）项的列表语法撰写一个待办事宜列表，并且支持子列表嵌套以及混用Markdown语法，例如：

- [ ] **Cmd Markdown 开发**
    - [ ] 改进 Cmd 渲染算法，使用局部渲染技术提高渲染效率
    - [ ] 支持以 PDF 格式导出文稿
    - [x] 新增Todo列表功能 [语法参考](https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments)
    - [x] 改进 LaTex 功能
        - [x] 修复 LaTex 公式渲染问题
        - [x] 新增 LaTex 公式编号功能 [语法参考](http://docs.mathjax.org/en/latest/tex.html#tex-eq-numbers)
- [ ] **七月旅行准备**
    - [ ] 准备邮轮上需要携带的物品
    - [ ] 浏览日本免税店的物品
    - [x] 购买蓝宝石公主号七月一日的船票

对应显示如下待办事宜 Todo 列表：

[ ] Cmd Markdown 开发
- [ ] 改进 Cmd 渲染算法，使用局部渲染技术提高渲染效率
- [ ] 支持以 PDF 格式导出文稿
- [x] 新增Todo列表功能语法参考
- [x] 改进 LaTex 功能
  - [x] 修复 LaTex 公式渲染问题
  - [x] 新增 LaTex 公式编号功能语法参考
[ ] 七月旅行准备
- [ ] 准备邮轮上需要携带的物品
- [ ] 浏览日本免税店的物品
- [x] 购买蓝宝石公主号七月一日的船票

Guide （redmine）

这是一篇讲解如何正确使用 Redmine 的 Markdown 的排版示例，学会这个很有必要，能让你的文章有更佳清晰的排版。

引用文本：Markdown is a text formatting syntax inspired

语法指导

普通内容

这段内容展示了在内容里面一些小的格式，比如：

加粗 - **加粗**
倾斜 - *倾斜*
~~删除线~~ - ~~删除线~~
Code 标记 - Code 标记
超级链接 - [超级链接](http://github.com)
huacnlee@gmail.com - [huacnlee@gmail.com](mailto:huacnlee@gmail.com)

提及用户

@刘文举(wenju) @梁泽宇(zeyu) ... 输入@ 将出现智能提示，通过@可以在课题详情和回复里面提及用户，信息提交以后，被提及的用户将会收到系统通知（右上角消息中心），以便让他来关注这个帖子或回帖。

表情符号 Emoji

Redmine 支持表情符号，你可以用系统默认的 Emoji 符号。
也可以用图片的表情，输入 : 将会出现智能提示。

一些表情例子

:smile: :laughing: :dizzy_face: :sob: :cold_sweat: :sweat_smile: :cry: :triumph: :heart_eyes: :satisfied: :relaxed: :sunglasses: :weary:

:+1: :-1: :100: :clap: :bell: :gift: :question: :bomb: :heart: :coffee: :cyclone: :bow: :kiss: :pray: :shit: :sweat_drops: :exclamation: :anger:

更多表情请访问：http://www.emoji-cheat-sheet.com

Redmine 链接

在任何使用文本格式的地方，Redmine都允许在资源（问题、变更、wiki页面...）间建立超链接。

#124 - #124 （链接至一个问题,若该问题已结束则会用删除线来表示）
#124-6 - #124-6 （链接至一个问题的回复）
[[wiki]] - [[wiki]] （链接至当前项目的名为wiki页面）
[[redmine_advice:FAQ]] - [[redmine_advice:FAQ]] （显示redmine_advice项目wiki页面的一个名为'FAQ'的链接）
[[redmine_advice:]] - [[redmine_advice:]] （显示redmine_advice项目wiki首页的链接）
document#17 （链接到id为17的文档）
document:Greetings （链接到标题为“Greeting”的文档）
document:"Some document" （文档标题包含空格时使用双引号来表示）
sandbox:document:"Some document" （链接至sandbox项目中标题为“Some document”的文档）
version#3 （链接至id为3的版本）
version:1.0.0 （链接到名称为“1.0.0”的版本）
version:"1.0 beta 2" （版本名称包含空格时使用双引号来表示）

更多redmine format 请访问 : redmine_text_formatting

大标题 - Heading 3

你可以选择使用 H2 至 H6，使用 ##(N) 打头，H1 不能使用，会自动转换成 H2。

NOTE: 别忘了 # 后面需要有空格！

Heading 4

Heading 5

Heading 6

代码块

普通

*emphasize*    **strong**
_emphasize_    __strong__
@a = 1

语法高亮支持

如果在 ``` 后面更随语言名称，可以有语法高亮的效果哦，比如:

演示 Ruby 代码高亮

class PostController < ApplicationController
  def index
    @posts = Post.desc("id).limit(10)
  end
end

演示 Rails View 高亮

<%= @posts.each do |post| %>
<div class="post"></div>
<% end %>

演示 YAML 文件

zh-CN:
  name: 姓名
  age: 年龄

Tip: 语言名称支持下面这些: java,ruby, python, js, html, erb, css, coffee, bash, json, yml, xml ...

有序、无序列表

无序列表

Ruby
- Rails
  - ActiveRecord
Go
- Gofmt
- Revel
Node.js
- Koa
- Express

有序列表

Node.js
Express
Koa
Sails
Ruby
Rails
Sinatra
Go

表格

如果需要展示数据什么的，可以选择使用表格哦

header 1	header 3
cell 1	cell 2
cell 3	cell 4
cell 5	cell 6

段落

留空白的换行，将会被自动转换成一个段落，会有一定的段落间距，便于阅读。

请注意后面 Markdown 源代码的换行留空情况。

这是一个注脚的文本。 ↩
这是另一个注脚的文本。 ↩

网友评论

本文标题：Markdown 教程

本文链接：https://www.haomeiwen.com/subject/ktuczttx.html

延伸阅读

深度阅读

您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！