前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >MarkDown高阶语法手册

MarkDown高阶语法手册

作者头像
代码的路
发布2022-08-01 14:49:02
1.1K0
发布2022-08-01 14:49:02
举报
文章被收录于专栏:代码的路代码的路

1. 内容目录

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

  • 1. 内容目录
  • 2. 标签分类
  • 3. 删除线
  • 4. 注脚
  • 5. LaTeX 公式
  • 6. 加强的代码块
  • 7. 流程图
  • 8. 序列图
  • 9. 甘特图
  • 10. Mermaid 流程图
  • 11. Mermaid 序列图
  • 12. 表格支持
  • 13. 定义型列表
  • 14. Html 标签
  • 15. 内嵌图标
  • 16. 待办事宜 Todo 列表

2. 标签分类

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

标签:数学 英语 Markdown

或者

Tags:数学 英语 Markdown

3. 删除线

使用 ~~ 表示删除线。

这是一段错误的文本。

4. 注脚

使用 [^keyword] 表示注脚。

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

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

5. LaTeX 公式

“$” 表示行内公式:

质能守恒方程可以用一个很简洁的方程式

E=mc^2

来表达。

“$$” 表示整行公式:

f'_i=N_t(f_i,w_i,h_i)

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

6. 加强的代码块

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

非代码示例:

代码语言:javascript
复制
$ sudo apt-get install vim-gnome

Python 示例:

代码语言:javascript
复制
@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 示例:

代码语言: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. 流程图

示例
代码语言:javascript
复制
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
代码语言:javascript
复制
Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!
示例 2
代码语言:javascript
复制
Title: Here is a title
A->B: Normal line
B-->C: Dashed line
C->>D: Open arrow
D-->>A: Dashed open arrow
更多语法参考:序列图语法参考

9. 甘特图

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

代码语言:javascript
复制
    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 流程图

代码语言:javascript
复制
    A[Hard edge] -->|Link text| B(Round edge)
    B --> C{Decision}
    C -->|One| D[Result one]
    C -->|Two| E[Result two]
更多语法参考:Mermaid 流程图语法参考

11. Mermaid 序列图

代码语言:javascript
复制
    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 写一个纵跨两行的表格:

代码语言:javascript
复制
<table>
    <tr>
        <th rowspan="2">值班人员</th>
        <th>星期一</th>
        <th>星期二</th>
        <th>星期三</th>
    </tr>
    <tr>
        <td>李强</td>
        <td>张明</td>
        <td>王平</td>
    </tr>
</table>

值班人员

星期一

星期二

星期三

李强

张明

王平

15. 内嵌图标

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

代码语言:javascript
复制
<i class="icon-weibo"></i>

即显示微博的图标:

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

代码语言:javascript
复制
<i class="icon-renren"></i>

即显示人人的图标:

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

16. 待办事宜 Todo 列表

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

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

[^footnote]: 这是一个 注脚文本

[^footnote2]: 这是另一个 注脚文本

学习更多编程知识,请关注我的公众号:

代码的路

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2022-07-29,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 代码的路 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 1. 内容目录
  • 2. 标签分类
  • 3. 删除线
  • 4. 注脚
  • 5. LaTeX 公式
  • 6. 加强的代码块
  • 7. 流程图
    • 示例
      • 更多语法参考:流程图语法参考
      • 8. 序列图
        • 示例 1
          • 示例 2
            • 更多语法参考:序列图语法参考
            • 9. 甘特图
              • 更多语法参考:甘特图语法参考
              • 10. Mermaid 流程图
                • 更多语法参考:Mermaid 流程图语法参考
                • 11. Mermaid 序列图
                  • 更多语法参考:Mermaid 序列图语法参考
                  • 12. 表格支持
                  • 13. 定义型列表
                  • 14. Html 标签
                  • 15. 内嵌图标
                  • 16. 待办事宜 Todo 列表
                  领券
                  问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档