.md(markdown)文件的基本編寫語法


構(gòu)建一個項目,往往需要反復(fù)實踐與驗證,初始構(gòu)建使用xmind整理思路與需求,初具模型后,通過visio呈現(xiàn)流程+md說明性文件,以便團隊開發(fā)。

  • 本文是我學(xué)習(xí).md的筆記。

什么是 Markdown

Markdown 是一種輕量級標記語言,創(chuàng)始人為約翰·格魯伯(John Gruber)。它允許人們「使用易讀易寫的純文本格式編寫文檔,然后轉(zhuǎn)換成有效的XHTML(或者HTML)文檔 」—— 維基百科>Markdown具有一系列衍生版本,用于擴展Markdown的功能(如表格、腳注、內(nèi)嵌HTML等等),這些功能原初的Markdown尚不具備,它們能讓Markdown轉(zhuǎn)換成更多的格式,例如LaTeX,Docbook。Markdown增強版中比較有名的有Markdown Extra、MultiMarkdown、 Maruku等。這些衍生版本要么基于工具,如Pandoc;要么基于網(wǎng)站,如GitHub和Wikipedia,在語法上基本兼容,但在一些語法和渲染效果上有改動。如果你看不懂以上對 Markdown 的定義,那也無所謂。約翰·格魯伯自己對Markdown的描述的重點也在于

標題

  • 第一種: 前面帶 # h幾即前面寫幾個 #
# 一級標簽          >     <h1>一級標簽</h1>
  • 第二種: 只能表示一級和二級標題,=和-的數(shù)量不限制,大于一個即可
 一級標簽           >     <h1>一級標簽</h1>
=========
  • 第三種: 和第一種方式不同之處是 添加了結(jié)束標簽
  # 一級標題 #                  >      <h1>一級標簽</h1>
  ## 二級標題 ##              >      <h2>二級標簽</h2>
  ### 三級標題 ###          >      <h3>三級標簽</h3>
  ...

列表

### 無序列表
* 1                             · 1       
+ 1            > 預(yù)覽            · 1
- 1                             · 1  
<ul>
  <li>1</li>
  <li>1</li>
  <li>1</li>
</ul>

### 有序列表
1. 列表                            1. 列表     
2. 列表            > 預(yù)覽          2. 列表
3. 列表                            3. 列表

!數(shù)字后面的點只能是英文點
??!有序列表的序號是根據(jù)第一行列表的數(shù)字順序來的
<ol>
  <li>列表</li>
  <li>列表</li>
  <li>列表</li>
</ol>

引用

分割線

鏈接

  • 2種鏈接方式:行內(nèi)式和參數(shù)式,鏈接文字用 [鏈接文字]標記 。
 ### 行內(nèi)式
 [Windows/Mac/Linux 全平臺客戶端](https://www.zybuluo.com/cmd/)
<p><a >Windows/Mac/Linux 全平臺客戶端</a></p>

###參數(shù)式
[Windows/Mac/Linux 全平臺客戶端](https://www.zybuluo.com/cmd/ 'title屬性')
<p><a  title="title屬性">Windows/Mac/Linux 全平臺客戶端</a></p>

圖片

![cmd-markdown-logo](https://www.zybuluo.com/static/img/logo.png)
<p><img src="https://www.zybuluo.com/static/img/logo.png" alt="cmd-markdown-logo" title="" /></p>
cmd-markdown-logo

代碼段

  • 單行使用 `` [ 反引號,鍵盤中esc下面那個鍵/英文狀態(tài)下 ]
 `我是單行文本`

預(yù)覽結(jié)果 _> 我是單行文本

  • 多行使用 `````` 注意:這里是是前后三個 ```


文本樣式

  *字體傾斜*                >        <em>字體傾斜</em>
  _字體傾斜_
  **字體加粗**              >        <strong>字體加粗</strong>
  __字體加粗__
  ~~字體刪除~~              >        <del>字體刪除</del>

  ! 符號與字體之間不要有空格

加強的代碼塊

支持四十一種編程語言的語法高亮的顯示,行號顯示。

非代碼示例:
    ` ` `
      $ sudo apt-get install vim-gnome
    ` ` `
$ sudo apt-get install vim-gnome

JavaScript 示例:
`` ` javascript
/**

  • nth element in the fibonacci series.
    */
    function fib(n) {
    var a = 1, b = 1;
    return a;
    }
    document.write(fib(10));
    `` `
    !三個反引號之間沒有空格
/**
* nth element in the fibonacci series.
*/
function fib(n) {
var a = 1, b = 1;
return a;
}
document.write(fib(10));

表格

| 項目        | 價格    |  數(shù)量   |
| --------    | -----: | :----:  |
| 計算機      | \$1600  |   5    |
| 手機        |   \$12  |   12   |
| 管線        |    \$1  |   234  |

: 是對齊方向
項目 價格 數(shù)量
計算機 $1600 5
手機 $12 12
管線 $1 234

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

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

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