Markdown 编辑器语法指南

标题

标题1
=================

标题2
-----------------

使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

粗斜体

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

段落

空格
输入 

空行
输入  

![fcd2e6120e395e13.image?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

aLVNDY

如果是要起一个新段落,只需要空出一行即可。
GH5DGX

⚠️注意: 句末分号要带上

列表

普通无序列表

segmentfault.com_markdown(4)

普通有序列表

segmentfault.com_markdown(5)

列表嵌套

segmentfault.com_markdown(6)

引用

普通引用

segmentfault.com_markdown(8)

引用文本前使用 [大于号+空格]
折行可以不加,新起一行都要加上哦

引用里嵌套引用

segmentfault.com_markdown(9)

最外层引用

多一个 > 嵌套一层引用

可以嵌套很多层

引用里嵌套列表

segmentfault.com_markdown(10)
  • 这是引用里嵌套的一个列表
  • 还可以有子列表
  • 子列表需要从 - 之后延后四个空格开始

引用里嵌套代码块

segmentfault.com_markdown(11)

同样的,在前面加四个空格形成代码块

或者使用 ``` 形成代码块

链接

文字链接 [链接名称](http://链接网址)

网址链接

高级链接技巧


一缕清风知识库

图片

跟链接的方法区别在于前面加了个感叹号 !,这样是不是觉得好记多了呢?


当然,你也可以像网址那样对图片网址使用变量
这个链接用 1 作为网址变量 百度.
然后在文档的结尾位变量赋值(网址)

分隔符

如果你有写分割线的习惯,可以新起一行输入三个减号-。当前后都有段落时,请空出一行:


代码

如果你只想高亮语句中的某个函数名或关键字,可以使用 `function_name()` 实现
通常编辑器根据代码片段适配合适的高亮方法,但你也可以用 ``` 包裹一段代码,并指定一种语言

segmentfault.com_markdown

支持的语言:1c, abnf, accesslog, actionscript, ada, apache, applescript, arduino, armasm, asciidoc, aspectj, autohotkey, autoit, avrasm, awk, axapta, bash, basic, bnf, brainfuck, cal, capnproto, ceylon, clean, clojure, clojure-repl, cmake, coffeescript, coq, cos, cpp, crmsh, crystal, cs, csp, css, d, dart, delphi, diff, django, dns, dockerfile, dos, dsconfig, dts, dust, ebnf, elixir, elm, erb, erlang, erlang-repl, excel, fix, flix, fortran, fsharp, gams, gauss, gcode, gherkin, glsl, go, golo, gradle, groovy, haml, handlebars, haskell, haxe, hsp, htmlbars, http, hy, inform7, ini, irpf90, java, javascript, json, julia, kotlin, lasso, ldif, leaf, less, lisp, livecodeserver, livescript, llvm, lsl, lua, makefile, markdown, mathematica, matlab, maxima, mel, mercury, mipsasm, mizar, mojolicious, monkey, moonscript, n1ql, nginx, nimrod, nix, nsis, objectivec, ocaml, openscad, oxygene, parser3, perl, pf, php, pony, powershell, processing, profile, prolog, protobuf, puppet, purebasic, python, q, qml, r, rib, roboconf, rsl, ruby, ruleslanguage, rust, scala, scheme, scilab, scss, smali, smalltalk, sml, sqf, sql, stan, stata, step21, stylus, subunit, swift, taggerscript, tap, tcl, tex, thrift, tp, twig, typescript, vala, vbnet, vbscript, vbscript-html, verilog, vhdl, vim, x86asm, xl, xml, xquery, yaml, zephir

也可以使用 4 空格缩进,再贴上代码,实现相同的的效果


segmentfault.com_markdown(1)

如你不需要代码高亮,可以用下面的方法禁用:


segmentfault.com_markdown(2)








表格

简单的表格形式

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |
表头 表头
单元格 单元格
单元格 单元格

设置表格的对齐方式:

  • -: 设置内容和标题栏居右对齐。
  • :- 设置内容和标题栏居左对齐。
  • :-: 设置内容和标题栏居中对齐。
| 左对齐 | 右对齐 | 居中对齐 |
| :-----| :----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
左对齐 右对齐 居中对齐
单元格 单元格 单元格
单元格 单元格 单元格

html表格

设备 设备文件名 文件描述符 类型
键盘 /dev/stdin 0 标准输入
显示器 /dev/stdout 1 标准输出
显示器 /dev/stderr 2 标准错误输出


























设备 设备文件名 文件描述符 类型
键盘 /dev/stdin 0 标准输入
显示器 /dev/stdout 1 标准输出
显示器 /dev/stderr 2 标准错误输出








流程图

1.横向流程图源码格式

graph LR
A[方形] -->B(圆角)
    B --> C{条件a}
    C -->|a=1| D[结果1]
    C -->|a=2| E[结果2]
    F[横向流程图]

2.竖向流程图源码格式:

graph TD
A[方形] --> B(圆角)
    B --> C{条件a}
    C --> |a=1| D[结果1]
    C --> |a=2| E[结果2]
    F[竖向流程图]

3.标准流程图源码格式:

st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op

4.标准流程图源码格式(横向):

st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st(right)->op(right)->cond
cond(yes)->io(bottom)->e
cond(no)->sub1(right)->op

5.UML时序图源码样例:

对象A->对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象A->对象B: 你真的好吗?

6.UML时序图源码复杂样例:

Title: 标题:复杂使用
对象A->对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象B->小三: 你好吗
小三-->>对象A: 对象B找我了
对象A->对象B: 你真的好吗?
Note over 小三,对象B: 我们是朋友
participant C
Note right of C: 没人陪我玩

7.UML标准时序图样例:

%% 时序图例子,-> 直线,-->虚线,->>实线箭头
  sequenceDiagram
    participant 张三
    participant 李四
    张三->王五: 王五你好吗?
    loop 健康检查
        王五->王五: 与疾病战斗
    end
    Note right of 王五: 合理 食物 
看医生... 李四-->>张三: 很好! 王五->李四: 你怎么样? 李四-->王五: 很好!

8.甘特图样例:

%% 语法示例
        gantt
        dateFormat  YYYY-MM-DD
        title 软件开发甘特图
        section 设计
        需求                      :done,    des1, 2014-01-06,2014-01-08
        原型                      :active,  des2, 2014-01-09, 3d
        UI设计                     :         des3, after des2, 5d
    未来任务                     :         des4, after des3, 5d
        section 开发
        学习准备理解需求                      :crit, done, 2014-01-06,24h
        设计框架                             :crit, done, after des2, 2d
        开发                                 :crit, active, 3d
        未来任务                              :crit, 5d
        耍                                   :2d
        section 测试
        功能测试                              :active, a1, after des3, 3d
        压力测试                               :after a1  , 20h
        测试报告                               : 48h

高级技巧

行内 HTML 元素

目前只支持部分段内 HTML 元素效果,包括
,如

键位显示


segmentfault.com_markdown(2)2021

代码块


segmentfault.com_markdown(3)2021

粗斜体


segmentfault.com_markdown(4)2021

符号转义

如果你的描述中需要用到 markdown 的符号,比如 _ # * 等,但又不想它被转义,这时候可以在这些符号前加反斜杠,如 \_ \# \* 进行避免。

segmentfault.com_markdown(5)2021

扩展

支持 jsfiddle、gist、runjs、优酷视频,直接填写 url,在其之后会自动添加预览点击会展开相关内容。

segmentfault.com_markdown(6)2021

公式

当你需要在编辑器中插入数学公式时,可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后,问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。如:

$$ x = {-b pm sqrt{b^2-4ac} over 2a}. $$
$$
x href{why-equal.html}{=} y^2 + 1
$$

同时也支持 HTML 属性,如:

$$ (x+1)^2 = class{hidden}{(x+1)(x+1)} $$

$$
(x+1)^2 = cssId{step1}{style{visibility:hidden}{(x+1)(x+1)}}
$$

你可能感兴趣的:(Markdown 编辑器语法指南)