Markdown 編輯器語法指南

標簽: Markdown


基本技巧

代碼

如果你只想高亮語句中的某個函數(shù)名或關(guān)鍵字,可以使用 function_name() 實現(xiàn)

通常編輯器根據(jù)代碼片段適配合適的高亮方法,但你也可以用 ```包裹一段代碼,并指定一種語言:

```javascript
$(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 空格縮進,再貼上代碼,實現(xiàn)相同的的效果

    def g(x):
        yield from range(x, 0, -1)
    yield from range(x)

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

```nohighlight
```

標題

文章內(nèi)容較多時,可以用標題分段:

標題1
======

標題2
-----

## 大標題 ## 
### 小標題 ###

粗斜體

*斜體文本*     _斜體文本_
**粗體文本**     __粗體文本__
***粗斜體文本***    ___粗斜體文本___

鏈接

常用鏈接方法

文字鏈接 `[鏈接名稱](http://鏈接網(wǎng)址)`
網(wǎng)址鏈接 `<http://鏈接網(wǎng)址>`

高級鏈接技巧

這個鏈接用 1 作為網(wǎng)址變量 [`Google][1].
這個鏈接用 yahoo 作為網(wǎng)址變量 `[Yahoo!][yahoo]`.
然后在文檔的結(jié)尾為變量賦值(網(wǎng)址)

[1]: http://www.google.com/
[yahoo]: http://www.yahoo.com/

列表

普通無序列表

- 列表文本前使用 [減號+空格]
+ 列表文本前使用 [加號+空格]
* 列表文本前使用 [星號+空格]

普通有序列表

1. 列表前使用 [數(shù)字+空格]
2. 我們會自動幫你添加數(shù)字
7. 不用擔心數(shù)字不對,顯示的時候我們會自動把這行的 7 糾正為 3 

列表嵌套

1. 列出所有元素:
    - 無序列表元素 A
        1. 元素 A 的有序子列表
   - 前面加四個空格
2. 列表里的多段換行:
    前面必須加四個空格,
    這樣換行,整體的格式不會亂
3. 列表里引用:

    > 前面空一行
    > 仍然需要在 >  前面加四個空格

4. 列表里代碼段:

    ``` 
    前面四個空格,之后按代碼語法 ``` 書寫
    ``` 

        或者直接空八個,引入代碼塊

引用

普通引用

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

引用里嵌套引用

> 最外層引用
> > 多一個 > 嵌套一層引用
> > > 可以嵌套很多層

引用里嵌套列表

> - 這是引用里嵌套的一個列表
> - 還可以有子列表`
>     * 子列表需要從 - 之后延后四個空格開始

引用里嵌套代碼塊

>  同樣的,在前面加四個空格形成代碼塊
>  
>  ``` 
> 或者使用 ``` 形成代碼塊
> ```

圖片

跟鏈接的方法區(qū)別在于前面加了個感嘆號 !,這樣是不是覺得好記多了呢?

[圖片上傳失敗...(image-e944bc-1514523710324)]

當然,你也可以像網(wǎng)址那樣對圖片網(wǎng)址使用變量

這個鏈接用 1 作為網(wǎng)址變量 [Google][1].
然后在文檔的結(jié)尾位變量賦值(網(wǎng)址)
[1]: http://www.google.com/logo.png

換行

如果另起一行,只需在當前行結(jié)尾加 2 個空格

在當前行的結(jié)尾加 2 個空格
這行就會新起一行`

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

分隔符

如果你有寫分割線的習慣,可以新起一行輸入三個減號-。當前后都有段落時,請空出一行:

前面的段落

---

后面的段落

高級技巧

行內(nèi) HTML 元素

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

鍵位顯示

使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重啟電腦

代碼塊

使用 `<pre></pre>` 元素同樣可以形成代碼塊

粗斜體

<b> Markdown 在此處同樣適用,如 *加粗* </b>`

符號轉(zhuǎn)義

如果你的描述中需要用到 markdown 的符號,比如 _ # * 等,但又不想它被轉(zhuǎn)義,這時候可以在這些符號前加反斜杠,如 \_ \# \*進行避免。

\_不想這里的文本變斜體\_
\*\*不想這里的文本被加粗\*\*

擴展

支持 jsfiddle、gist、runjs、優(yōu)酷視頻,直接填寫 url,在其之后會自動添加預覽點擊會展開相關(guān)內(nèi)容。

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

公式

當你需要在編輯器中插入數(shù)學公式時,可以使用兩個美元符 $$ 包裹 TeX 或 LaTeX 格式的數(shù)學公式來實現(xiàn)。提交后,問答和文章頁會根據(jù)需要加載 Mathjax 對數(shù)學公式進行渲染。如:

$$ 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)}}
$$
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容