mkdocs 和 mardown文檔

mardown是編輯器語言,mkdocs是文檔工具、mkdocs文檔的編寫語言是mardown

需要Python 和 Python package manager 來安裝 MkDocs . 可以通過以下命令查看是否安裝了上述依賴:

$ python --version
$ pip --version

安裝MkDocs

使用 pip 安裝 mkdocs :

$ pip install mkdocs

mkdocs已經(jīng)安裝到你的系統(tǒng). 運行 mkdocs help 以檢查是否正確安裝.

$ mkdocs help

創(chuàng)建項目

$ mkdocs new my-project
$ cd my-project

有一個配置文件 mkdocs.yml, 和一個包含文檔源碼的 docs 文件夾. 在 docs 文件夾里包含了一個名為 index.md 的文檔.

MkDocs 包含了一個內(nèi)建的服務(wù)器以預(yù)覽當(dāng)前文檔. 控制臺切換當(dāng)前目錄到 mkdocs.yml 配置文件相同文件夾,

輸入 mkdocs serve 命令以啟動內(nèi)建服務(wù)器:

$ mkdocs serve

在瀏覽器中打開 http://127.0.0.1:8000/ , 你將看到頁面:

站點生成

我們現(xiàn)在已經(jīng)可以發(fā)布 MkLorum 文檔了. 通過以下命令生成文檔.

$ mkdocs build

mardown的基礎(chǔ)語法:

標(biāo)簽:H1 H2 H3.....
# Headline 1
## Headline 2
### Headline 3


標(biāo)簽:P、B 回車換行就是P,雙下劃線和雙星號都是加粗
Usetwoasterisksfor strongemphasis.
Or,ifyouprefer,__usetwoundetead__ is  **abc**
引用
>ThismoduleimplementsanumberofiteratorbuildingblocksinspiredbyconstructsfromAPL,
Haskell,andSML.EachhasbeenrecastinaformsuitableforPython.


各種列表
* Apple
* Orange
+ Peach
+ Banana
- Peach
- Banana

嵌套列表
1. Fruit  
    * Apple  
    * Orange  
    * Peach  
    * Banana
2. Vegetable  
    + Potato  
    + Cabbage
標(biāo)簽:A 和 img
This is an [example link](http://example.com/).

代碼塊
三個` 開始   三個`結(jié)束
最后編輯于
?著作權(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)容

  • 1、通過CocoaPods安裝項目名稱項目信息 AFNetworking網(wǎng)絡(luò)請求組件 FMDB本地數(shù)據(jù)庫組件 SD...
    陽明AI閱讀 16,214評論 3 119
  • 但愿有一天 能把你沖進我的咖啡里 甚至可以想象到 你是什么樣的風(fēng)味 伴著每一口你帶給我的回甘 夜晚也被你打擾的無法...
    Vision碎碎閱讀 352評論 0 0

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