Markdown基础

发表于 更新于 分类于 阅读次数：

附 本文的Markdown源码:
GitHub - johnhu94/Markdown: Markdown基础整理
点击”Raw”可看到源码，欢迎fork或star~

  • Markdown和扩展Markdown简洁的语法
  • 代码块高亮
  • 图片链接和图片上传
  • *LaTex*数学公式
  • 导入导出Markdown文件
  • 丰富的快捷键

快捷键

  • 加粗 Ctrl + B
  • 斜体 Ctrl + I
  • 引用 Ctrl + Q
  • 插入链接 Ctrl + L
  • 插入代码 Ctrl + K
  • 插入图片 Ctrl + G
  • 提升标题 Ctrl + H
  • 有序列表 Ctrl + O
  • 无序列表 Ctrl + U
  • 横线 Ctrl + R
  • 撤销 Ctrl + Z
  • 重做 Ctrl + Y

Markdown及扩展

Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档，然后转换成格式丰富的HTML页面。 —— [ 维基百科 ]

使用简单的符号标识不同的标题，将某些文字标记为粗体或者斜体，创建一个链接等，详细语法参考帮助？。

表格

Markdown　Extra　表格语法：

项目 价格
Computer $1600
Phone $12
Pipe $1

可以使用冒号来定义对齐方式：

项目 价格 数量
Computer 1600 元 5
Phone 12 元 12
Pipe 1 元 234

定义列表

Markdown　Extra　定义列表语法：

项目1

: 定义 A

项目2

: 定义 B

项目3

: 定义 C

: 定义 D

1
> 定义D内容

代码块

代码块语法遵循标准markdown代码，例如：

1
2
3
4
5
6
7
8
9
10
@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'''

自定义字体颜色(github中看不到颜色):

Hello

删除线

Hello

###脚注 生成一个脚注[^footnote]. [^footnote]: 这里是 脚注 的 内容.

目录

用 [TOC]来生成目录：

[TOC]

数学公式

使用MathJax渲染LaTex 数学公式，详见math.stackexchange.com.

  • 行内公式，数学公式为：$\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$。

  • 块级公式：

    $ x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$

更多LaTex语法请参考

LaTeX技巧10：LaTeX数学公式输入初级入门_

LaTeX 第五课：数学公式排版

UML 图:

可以渲染序列图：

1
2
3
张三->李四: 嘿，小四儿, 写博客了没
Note right of 李四: 李四愣了一下，说：
李四-->张三: 忙得吐血，哪有时间写。

或者流程图：

1
2
3
4
5
6
7
8
st=>start: 开始
e=>end: 结束
op=>operation: 我的操作
cond=>condition: 确认？

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