Markdown 语法说明

658 阅读6分钟

Markdown 语法说明

欢迎任何形式的转载,转载请保留原文链接:juejin.cn/post/709162…

目录(点击链接仅 Github 有效)

使用注意项

  • 文件与目录均不要带空格,防止 md 文件间无法跳转,暂未发现有效手段

标准语法不支持的,Github 支持

目录,代码如下,效果见目录章节

<!-- GFM-TOC -->
* [使用注意项](#使用注意项)
* [标准语法不支持的,Github 支持](#标准语法不支持的github-支持)
* [标准语法不支持的,Github 也不支持](#标准语法不支持的github-也不支持)
* [Github 不支持的增强型 Markdown](#github-不支持的增强型-markdown)
* [标准语法说明](#标准语法说明)
    * [标题](#标题)
    * [列表](#列表)
    * [超链接、图片](#超链接、图片)
    * [字体样式](#字体样式)
    * [段落、换行、首行缩进、分割线](#段落、换行、首行缩进、分割线)
    * [引用](#引用)
    * [代码](#代码)
    * [表格](#表格)
    * [代码高亮](#代码高亮)
* [参考文献与版本同步](#参考文献与版本同步)
<!-- GFM-TOC -->

目录使用说明,即链接填写说明

  • 说明1:要用[-]符号替代空格
  • 说明2:去掉中文符号
  • 说明3:全部用小写
  • 适用:firefox、Chrome
  • 不适用:未发现

代办项

- [x] @mentions, #refs, [links](), **formatting**, and <del>tags</del> supported
- [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item

标准语法不支持的,Github 也不支持

字体颜色背景

<font face="黑体">我是黑体字</font>
<font face="微软雅黑">我是微软雅黑</font>
<font face="STCAIYUN">我是华文彩云</font>
<font color=#0099ff size=7 face="黑体">color=#0099ff size=72 face="黑体"</font>
<font color=#00ffff size=72>color=#00ffff</font>
<font color=gray size=72>color=gray</font>
<table><tr><td bgcolor=orange>背景色是:orange</td></tr></table>

Github 不支持的增强型 Markdown

  • cmd markdown

标准语法说明

标题

共 6 级,建议在 # 后加一个空格

# 一级标题
## 二级标题
#### 四级标题

列表

- 无序列表
- 无序列表

* 无序列表
* 无序列表

+ 无序列表
+ 无序列表

1. 有序列表
1. 有序列表
1. 有序列表

1. 有序列表
2. 有序列表
3. 有序列表

1928\. 不是有序

- 无序列表
	> 缩进引用,引用前加 4 个空格或 1 个 tab,否则引用不会缩进对齐
- 无序列表

1. 有序列表
	> 缩进引用,引用前加 4 个空格或 1 个 tab,否则引用不会缩进对齐
2. 有序列表,编号必须是1,2,3,...,否则编号会重 1 开始

- 无序列表
		缩进代码,但 github 无效
- 无序列表

说明:

  • 有序列表间插入空行,不会影响编号
  • 无序和有序之间只存在空行时,会导致两者变成同一种
  • 缩进除引用外,对其他符号也有效,如有序嵌套无序等等

效果:

1928. 不是有序

  1. 有序列表

    缩进引用,引用前加 4 个空格或 1 个 tab,否则引用不会缩进对齐

  2. 有序列表

    缩进代码,gitee 有效且代码块前无空格
    
  3. 有序列表 缩进代码

  4. 有序列表,编号必须是1,2,3,...,否则编号会重 1 开始

超链接、图片

[超链接标题](超链接地址)

![图片标题](图片地址)

字体样式

注意:符号和文字之间不能加空格

*斜体*
_斜体_
**粗体**
__粗体__
***粗体+斜体***
___粗体+斜体___
~~删除~~

\*斜体不生效,同时显示星号\*

效果:

  • 斜体
  • 斜体
  • 粗体
  • 粗体
  • 粗体+斜体
  • 粗体+斜体
  • 删除
  • *斜体不生效,同时显示星号*

段落、换行、首行缩进、分割线

段落:段落之间空一行
 
换行符:一行结束时输入两个空格,不推荐

首行缩进:输入两个全角中文空格,不能用四个半角空格替代

分割线:三个 - 或 *

效果:
末尾两个空格换行
末尾没有空格不换行 末尾没有空格不换行

引用

> ### 引用内容三级标题
> 引用内容

效果:

引用可以对其他符号生效(如标题,有序列表等等)

引用内容:三级标题

代码

代码块写法01:使用两个【`` `】(要去掉空格)包裹即可,一般

代码块第二种写法:代码前面 4 个空格或 1 个 tab

内嵌代码:`内嵌代码`,用两个 ` 把中间的代码包裹起来

内嵌代码:``内嵌代码含 ` 的情况``,如果包裹内容含 ` 则用两个连续的 ` 包裹

效果:
内嵌代码:内嵌代码 效果
内嵌代码:内嵌代码含 ` 的情况 效果

表格

| Tables        | Are           |   Cool |
| ------------- |:-------------:| ------:|
| 右对齐        |   居中对齐    | 右对齐 |
| col 3 is      | right-aligned |  $1600 |
| col 2 is      | centered      |    $12 |
| zebra stripes | are neat      |     $1 |

效果:

TablesAreCool
右对齐居中对齐右对齐
col 3 isright-aligned$1600
col 2 iscentered$12
zebra stripesare neat$1

代码高亮

在MarkDown编辑时,我们经常需要引入一段代码,此时若果代码能高亮显示,界面就会非常友好。

`` ` key
代码段
`` `

其中,使用以下方式来标记语言时,下面的就会表格就会派上用场了

以下表格为引用

languagekey
1C1c
ActionScriptactionscript
Apacheapache
AppleScriptapplescript
AsciiDocasciidoc
AspectJasciidoc
AutoHotkeyautohotkey
AVR Assembleravrasm
Axaptaaxapta
Bashbash
BrainFuckbrainfuck
Cap’n Protocapnproto
Clojure REPLclojure
Clojureclojure
CMakecmake
CoffeeScriptcoffeescript
C++cpp
C#cs
CSScss
Dd
Dartd
Delphidelphi
Diffdiff
Djangodjango
DOS.batdos
Dustdust
Elixirelixir
ERB(Embedded Ruby)erb
Erlang REPLerlang-repl
Erlangerlang
FIXfix
F#fsharp
G-code(ISO 6983)gcode
Gherkingherkin
GLSLglsl
Gogo
Gradlegradle
Groovygroovy
Hamlhaml
Handlebarshandlebars
Haskellhaskell
Haxehaxe
HTMLhtml
HTTPhttp
Ini fileini
Javajava
JavaScriptjavascript
JSONjson
Lassolasso
Lessless
Lisplisp
LiveCodelivecodeserver
LiveScriptlivescript
Lualua
Makefilemakefile
Markdownmarkdown
Mathematicamathematica
Matlabmatlab
MEL (Maya Embedded Language)mel
Mercurymercury
Mizarmizar
Monkeymonkey
Nginxnginx
Nimrodnimrod
Nixnix
NSISnsis
Objective Cobjectivec
OCamlocaml
Oxygeneoxygene
Parser 3parser3
Perlperl
PHPphp
PowerShellpowershell
Processingprocessing
Python’s profiler outputprofile
Protocol Buffersprotobuf
Puppetpuppet
Pythonpython
Qq
Rr
RenderMan RIBrib
Roboconfroboconf
RenderMan RSLrsl
Rubyruby
Oracle Rules Languageruleslanguage
Rustrust
Scalascala
Schemescheme
Scilabscilab
SCSSscss
Smalismali
SmallTalksmalltalk
SMLsml
SQLsql
Statastata
STEP Part21(ISO 10303-21)step21
Stylusstylus
Swiftswift
Tcltcl
Textex
texttext/plain
Thriftthrift
Twigtwig
TypeScripttypescript
Valavala
VB.NETvbnet
VBScript in HTMLvbscript-html
VBScriptvbscript
Verilogverilog
VHDLvhdl
Vim Scriptvim
Intel x86 Assemblyx86asm
XLxl
XMLxml
YAMLym

参考文献与版本同步

参考文献:

博客同步版本:

  • 2022-04-28:首发博客