如何書寫.md格式文檔


md即markdown,百度的解釋:Markdown是一種可以使用普通文本編輯器編寫的標記語言,通過簡單的標記語法,它可以使普通文本內容具有一定的格式。

總是可以自github上看到有一個這樣說明性的描述文件。

現在的前端基本上都用上了前端構建工具,那就難免要寫一些readme等等的說明性文件。

但是這樣的文件一般都是.md的文件,編寫的語法自然跟其他格式的文件有所區別,置於為什么要用這種格式的文件,我也不知道,大家好像都這么用,跟着用就對了!

 

寫.md的好工具,Typora是一款輕便簡潔的Markdown編輯器,支持即時渲染技術,這也是與其他Markdown編輯器最顯著的區別。即時渲染使得你寫Markdown就想是寫Word文檔一樣流暢自如,不像其他編輯器的有編輯欄和顯示欄。簡言之,好用,但是應該學着記一下一些常用的,不要太依賴!

一、標題

標題其實和HTML中的h系列很像,想要設置為標題的文字前面加#來表示
一個#是一級標題,二個#是二級標題,以此類推。支持六級標題。

注:標准語法一般在#后跟個空格再寫文字,

示例:

# 這是一級標題 ## 這是二級標題 ### 這是三級標題 #### 這是四級標題 ##### 這是五級標題 ###### 這是六級標題 

效果如下:

這是一級標題

這是二級標題

這是三級標題

這是四級標題

這是五級標題
這是六級標題

二、字體

  • 加粗

要加粗的文字左右分別用兩個*號包起來

  • 斜體

要傾斜的文字左右分別用一個*號或者用_包起來

  • 斜體加粗

要傾斜和加粗的文字左右分別用三個*號包起來

  • 刪除線

要加刪除線的文字左右分別用兩個~~號包起來

示例:

**這是加粗的文字**
*這是傾斜的文字*`
***這是斜體加粗的文字***
~~這是加刪除線的文字~~

效果如下:

這是加粗的文字
這是傾斜的文字
這是斜體加粗的文字
這是加刪除線的文字


三、引用

在引用的文字前加>即可。引用也可以嵌套,如加兩個>>三個>>>
n個...

示例:

>這是引用的內容
>>這是引用的內容 >>>這是引用的內容 

效果如下:

  • 這是引用的內容

這是引用的內容
這是引用的內容
這是引用的內容

四、分割線

三個或者三個以上的 - 或者 * 都可以。

示例:

---
***

效果如下:
可以看到,顯示效果是一樣的。


五、圖片

語法:

![圖片alt](圖片地址 ''圖片title'') 圖片alt就是顯示在圖片下面的文字,相當於對圖片內容的解釋。 圖片title是圖片的標題,當鼠標移到圖片上時顯示的內容。title可加可不加 

**上傳本地圖片直接拖進去

六、超鏈接

語法:

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

示例:

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

效果如下:

百度


七、列表

  • 無序列表

語法:
無序列表用 - + * 任何一種都可以

- 列表內容
+ 列表內容
* 列表內容

注意:- + * 跟內容之間都要有一個空格

效果如下:

  • 列表內容

  • 列表內容

  • 列表內容

  • 有序列表

語法:
數字加點

1.列表內容
2.列表內容
3.列表內容

注意:序號跟內容之間要有空格

效果如下:

1.列表內容
2.列表內容
3.列表內容

  • 列表嵌套

上一級和下一級之間敲三個空格即可

  • 一級無序列表內容

    • 二級無序列表內容
    • 二級無序列表內容
    • 二級無序列表內容
  • 一級無序列表內容

    1. 二級有序列表內容
    2. 二級有序列表內容
    3. 二級有序列表內容
  1. 一級有序列表內容

    • 二級無序列表內容
    • 二級無序列表內容
    • 二級無序列表內容
  2. 一級有序列表內容

    1. 二級有序列表內容
    2. 二級有序列表內容
    3. 二級有序列表內容

八、表格

語法:

表頭|表頭|表頭 ---|:--:|---: 內容|內容|內容 內容|內容|內容 第二行分割表頭和內容。 - 有一個就行,為了對齊,多加了幾個 文字默認居左 -兩邊加:表示文字居中 -右邊加:表示文字居右 注:原生的語法兩邊都要用 | 包起來。此處省略 

示例:

| 表頭 | 表頭 | 表頭 | | --- | --- | --- | |第一行|第一行|第一行| |第二行|第二行|第二行| |第三行|第三行|第三行| 

效果如下:

表頭 表頭 表頭
第一行 第一行 第一行
第二行 第二行 第二行
第三行 第三行 第三行

九、代碼

語法:
單行代碼:代碼之間分別用一個反引號包起來

    `代碼內容` 

代碼塊:代碼之間分別用三個反引號包起來,且兩邊的反引號單獨占一行

    ``` 代碼內容 ``` 

以上就是常用的格式,很簡單,大家試着寫一寫;很快就能上手。

參考文獻
https://www.jianshu.com/p/f378e3f2e7e1


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM