文檔筆記之 Mkdocs 2020-10-03

←↑→↓↖↙↗↘??
unicode=Geometric Shapes
? 僅僅個(gè)別字不同的時(shí)候的對(duì)比標(biāo)識(shí)

? 著重強(qiáng)調(diào)

??◆ 1、
??◆ 2、
??◆ 3、

??
??
??
??
??
??
??
??

Miscellaneous Symbols

?
Dingbats
? 重點(diǎn)記憶,個(gè)人總結(jié)的點(diǎn),或者知識(shí)。
??
?

章節(jié)號(hào) 內(nèi)容????????????
1圖片格式(png) 寬度大于620px,保持高寬比減低為620px
1-1 應(yīng)用
1-1-1 方法

??
??
??
??
??
??
??
??
??仔細(xì)回顧思索,其實(shí)我們能夠發(fā)現(xiàn),在人生這個(gè)不斷的學(xué)習(xí)充電的過(guò)程中,記錄學(xué)習(xí)的過(guò)程是十分重要的,不但是學(xué)習(xí)當(dāng)下的補(bǔ)充和鞏固,同時(shí)也是將來(lái)回憶重溫的必要基礎(chǔ)。

??
??
??

  • 1?安裝mkdocs(基于Python)

??沒(méi)有安裝python必須要首先安裝python環(huán)境。
??MkDocs 支持 Python versions 3.5, 3.6, 3.7, 3.8, and pypy3.
??某些情況下,因?yàn)閜ython安裝包不太新的關(guān)系,會(huì)造成pip工具版本過(guò)低,影響安裝mkdocs,所以有必要先更新一下pip。

pip install --upgrade pip

??? 然后安裝mkdocs。使用國(guó)內(nèi)源安裝會(huì)比較快一些。
??國(guó)內(nèi)源安裝的格式:pip install -i 國(guó)內(nèi)源網(wǎng)址 包名

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple mkdocs

??下面是一些國(guó)內(nèi)源

??清華:https://pypi.tuna.tsinghua.edu.cn/simple
??阿里云:http://mirrors.aliyun.com/pypi/simple/
??中國(guó)科技大學(xué) https://pypi.mirrors.ustc.edu.cn/simple/
??華中理工大學(xué):http://pypi.hustunique.com/
??山東理工大學(xué):http://pypi.sdutlinux.org/

??? 安裝完畢,查看一下mkdocs的版本

mkdocs --version

??? 官方文檔中,提及了一個(gè)工具click-man,實(shí)驗(yàn)安裝

??查看內(nèi)容,其實(shí)就是生成了mkdocs的幫助文檔。里面有mkdocs的使用。這里就是Linux下的幫助文檔的格式。

??
??
??

  • 2?起步

??◆ 1、新建工程。做準(zhǔn)備工作如下:

??然后,輸入以下命令:

mkdocs new my-project
cd my-project

??此時(shí)會(huì)在文件夾下,產(chǎn)生一個(gè)mkdocs.yml文件和docs文件夾。其中:
mkdocs.yml是一個(gè)配置文件。

docs文件夾下保存你的文檔的源文件。此時(shí)下面只有一個(gè)名為index.md的文件。

??◆ 2、預(yù)覽工程。

??MkDocs帶有內(nèi)置的開(kāi)發(fā)服務(wù)器,可讓您在處理文檔時(shí)預(yù)覽文檔。首先,先保證當(dāng)前路徑和mkdocs.yml在同一路徑下。

??然后輸入命令:

mkdocs serve

??此時(shí)將看到默認(rèn)的主頁(yè)顯示。

??注意:dev-server支持自動(dòng)裝載,只要工程目錄下的配置文件、文檔源文件或者是 theme目錄發(fā)生改變,dev-server就會(huì)刷新整個(gè)工程,并實(shí)時(shí)顯示修改結(jié)果。

??這里修改了配置文件,dev-server就會(huì)自動(dòng)刷新,并實(shí)時(shí)顯示。

??
??
??

  • 3?添加文檔頁(yè)面

??文檔的范例是使用curl命令。

curl 'https://jaspervdj.be/lorem-markdownum/markdown.txt' > docs/about.md

??具體分析分析,上述命令應(yīng)該是在docs的文件夾下,產(chǎn)生一個(gè)about.md文件。那么我們手動(dòng)添加一下試試。首先我們查看一下上述文檔的內(nèi)容是什么:

??然后,復(fù)制一下index,改名為about。把上述文件的內(nèi)容復(fù)制到about文件中。

??◆ 在配置文件中添加導(dǎo)航信息
??代碼為:

site_name: Lil
nav:
    - Home: index.md
    - About: about.md

??
??
??

  • 4?文檔主題設(shè)置

??將mkdocs.yml配置文件修改為:

site_name: Lil
nav:
    - Home: index.md
    - About: about.md
theme: readthedocs

??
??
??

  • 5?修改 the Favicon Icon

??在docs文件夾下,新建一個(gè)img文件夾

??然后在文件夾中,放入自定義的圖標(biāo)文件,名為favicon.ico

??要注意的是,這個(gè)修改,要Building之后才能看到效果。

??
??
??

  • 6?編譯文檔 Building the site

??編輯完畢后,開(kāi)始編譯文檔.首先,進(jìn)入mkdocs.yml路徑下,使用命令:

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

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