Markdown 編輯器語法指南

引子:    

    51cto裏面編輯博客的時候默認是使用Markdown編輯器,到網上了解了一下這個編輯器,使用非常簡單的符號進行編排,很簡潔,是純文本格式,對於文檔中嵌套程序的情況下還是比較方便。其中我感覺最不爽的是編輯的時候左右兩塊區域,視野很狹窄,感覺很憋屈,反正我現在是不怎麼習慣。下面是從網上轉載的一篇語法指南,當做參考。


原文鏈接:

https://segmentfault.com/markdown#articleHeader6


基本技巧

代碼

如果你只想高亮語句中的某個函數名或關鍵字,可以使用 `function_name()` 實現

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

```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 空格縮進,再貼上代碼,實現相同的的效果

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

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

```nohighlight```

標題

文章內容較多時,可以用標題分段:

標題1======標題2-----## 大標題 ##### 小標題 ###

粗斜體

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

鏈接

常用鏈接方法

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

高級鏈接技巧

這個鏈接用 1 作爲網址變量 [Google][1].
這個鏈接用 yahoo 作爲網址變量 [Yahoo!][yahoo].
然後在文檔的結尾爲變量賦值(網址)  [1]: http://www.google.com/  [yahoo]: http://www.yahoo.com/

列表

普通無序列表

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

普通有序列表

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

列表嵌套

1. 列出所有元素:    - 無序列表元素 A        1. 元素 A 的有序子列表    - 前面加四個空格2. 列表裏的多段換行:    前面必須加四個空格,    這樣換行,整體的格式不會亂3. 列表裏引用:    > 前面空一行    > 仍然需要在 >  前面加四個空格4. 列表裏代碼段:    ```    前面四個空格,之後按代碼語法 ``` 書寫    ```        或者直接空八個,引入代碼塊

引用

普通引用

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

引用裏嵌套引用

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

引用裏嵌套列表

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

引用裏嵌套代碼塊

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

圖片

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

![圖片名稱](http://圖片網址)

當然,你也可以像網址那樣對圖片網址使用變量

這個鏈接用 1 作爲網址變量 [Google][1].
然後在文檔的結尾位變量賦值(網址) [1]: http://www.google.com/logo.png

換行

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

在當前行的結尾加 2 個空格  這行就會新起一行

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

分隔符

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

前面的段落---後面的段落


高級技巧

行內 HTML 元素

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

鍵位顯示

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

代碼塊

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

粗斜體

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

符號轉義

如果你的描述中需要用到 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

公式

當你需要在編輯器中插入數學公式時,可以使用兩個美元符 $$ 包裹 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)}}$$


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章