markdown语法

Posted wy715

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了markdown语法相关的知识,希望对你有一定的参考价值。

[TOC]

基本技巧

一、标题

在想要设置为标题的文字前面加#来表示
一个#是一级标题,二个#是二级标题,以此类推。支持六级标题。

注:标准语法一般在#后跟个空格再写文字。

示例:

# 这是一级标题
## 这是二级标题
### 这是三级标题
#### 这是四级标题
##### 这是五级标题
###### 这是六级标题

效果如下:

这是一级标题

这是二级标题

这是三级标题

这是四级标题

这是五级标题
这是六级标题

二、字体

  • 加粗
    要加粗的文字左右分别用两个*号包起来
  • 斜体
    要倾斜的文字左右分别用一个*号包起来
  • 斜体加粗
    要倾斜和加粗的文字左右分别用三个*号包起来
  • 删除线
    要加删除线的文字左右分别用两个~~号包起来

示例:

**这是加粗的文字**
*这是倾斜的文字*`
***这是斜体加粗的文字***
~~这是加删除线的文字~~

效果如下:
这是加粗的文字
这是倾斜的文字`
这是斜体加粗的文字
这是加删除线的文字

三、引用

在引用的文字前加>即可。
引用也可以嵌套,如加两个>>三个>>> n个... 貌似可以一直加下去,但没神马卵用

示例:

>这是引用的内容
>>这是引用的内容
>>>>>>>>>>这是引用的内容

效果如下:

这是引用的内容

这是引用的内容

这是引用的内容

四、换行

另起一行

只需在当前行结尾2个空格

新起一行

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

五、分割线

三个或者三个以上- 或者 * 都可以。

示例:

---
----
***
*****

效果如下:




六、图片

语法:

![图片alt](图片地址 ‘‘图片title‘‘)

图片alt就是显示在图片下面的文字,相当于对图片内容的解释。
图片title是图片的标题,当鼠标移到图片上时显示的内容。title可加可不加

示例:

![blockchain](https://ss0.bdstatic.com/70cFvHSh_Q1YnxGkpoWK1HF6hhy/it/
u=702257389,1274025419&fm=27&gp=0.jpg "区块链")

效果如下:
技术分享图片

七、超链接

语法:

[超链接名](超链接地址 "超链接title")
title可加可不加

示例:

[简书](http://jianshu.com)
[百度](http://baidu.com)

效果如下:
简书
百度

八、列表

无序列表

语法:无序列表用 - + * 任何一种都可以

- 列表内容
+ 列表内容
* 列表内容

注意:- + * 跟内容之间都要有一个空格

效果如下:

  • 列表内容
  • 列表内容
  • 列表内容

有序列表

语法:数字加点

1. 列表内容
1. 列表内容
1. 列表内容

注意:序号跟内容之间要有空格
注意:不要求数字一定要连续,可以都是1.

效果如下:

  1. 列表内容
  2. 列表内容
  3. 列表内容

列表嵌套

上一级和下一级之间敲三个空格即可

- 一级无序列表内容
   - 二级无序列表内容
   - 二级无序列表内容
   - 二级无序列表内容
- 一级无序列表内容
   - 二级无序列表内容
   - 二级无序列表内容
   - 二级无序列表内容

效果如下:

  • 一级无序列表内容
  • 二级无序列表内容
  • 二级无序列表内容
  • 二级无序列表内容
  • 一级无序列表内容
  • 二级无序列表内容
  • 二级无序列表内容
  • 二级无序列表内容

九、表格

语法:

列之间以 | 分隔,  

第二行分割表头和内容。
标题与文本之间以 --- 分隔, 用:表示显示位置,  
文字默认居左
:----表示靠左显示,
:-----:居中显示,
---:靠右显示

 注:- 有一个就行,为了对齐,多加了几个
 注:原生的语法两边都要用 | 包起来。此处省略
| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3 is      | right-aligned | $1600 |
| col 2 is      | centered      |   $12 |
| zebra stripes | are neat      |    $1 |

效果如下:
| Tables | Are | Cool |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |

十、脚注

在要添加注释的词语后面增加 [^1] ,结尾加入[^1]:空格 注释内容

hello[^1]
[^1]: hi

点击保存后的效果:
hello[^1]
[^1]: hi

十一、 目录

[TOC]生成目录, 自动把文档中带#标题生成目录

十二、代码

语法:
单行代码
代码内容

多行代码

代码内容

效果如下:

单行

create database hero;

多行

function fun(){
  echo "这是一句非常牛逼的代码";
}
fun();

代码高亮

如果你只想高亮语句中的某个函数名或关键字,可以使用 function_name() 实现

通常编辑器根据代码片段适配合适的高亮方法,但你也可以用 ``` 包裹一段代码,并指定一种语言

$(document).ready(function () {
    alert(‘hello world‘);
});

支持的语言: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 空格缩进,再贴上代码,实现相同的的效果
```
def g(x):
yield from range(x, 0, -1)
yield from range(x)
```
如你不需要代码高亮,可以用下面的方法禁用:

```nohighlight
```

高级技巧

一 行内 HTML 元素

目前只支持部分段内 HTML 元素效果,包括 <kdb> <b> <i> <em> <sup> <sub> <br> ,如

键位显示

使用 Ctrl+Alt+Del 重启电脑

代码块

使用 <pre></pre> 元素同样可以形成代码块

粗斜体

<b> Markdown 在此处同样适用,如 *加粗* </b>
Markdown 在此处同样适用,如 加粗

符号转义

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

\_不想这里的文本变斜体\_
\*\*不想这里的文本被加粗\*\*

二 扩展

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

http://{url_of_the_fiddle}/embedded/[{tabs}/[{style}]]/
https://gist.github.com/{gist_id}
http://runjs.cn/detail/{id}
http://v.youku.com/v_show/id_{video_id}.html

http://{url_of_the_fiddle}/embedded/[{tabs}/[{style}]]/
https://gist.github.com/{gist_id}
http://runjs.cn/detail/{id}
http://v.youku.com/v_show/id_{video_id}.html



































以上是关于markdown语法的主要内容,如果未能解决你的问题,请参考以下文章

markdown PHPExcel Notes和代码片段

markdown Git代码片段

markdown 岩组代码片段

markdown [magento] - 代码片段

markdown 在WordPress中使用jQuery代码片段

markdown 打字稿...编码说明,提示,作弊,指南,代码片段和教程文章