MkDocs使用

安裝Python

首先需要提前安裝好python,因?yàn)橐褂胮ip工具下載mkdocs。

安裝mkdocs包

pip install mkdocs


使用

創(chuàng)建項(xiàng)目

mkdocs new projectName

項(xiàng)目創(chuàng)建成功以后,會(huì)得到一個(gè)名為你指定名字的一個(gè)文件夾,其中包含有兩個(gè)文件,一個(gè)是名為docs的文件夾,另一個(gè)是名為mkdocs.yml的配置文件。docs文件夾中包含有一個(gè)名為index.md的文件,網(wǎng)站的內(nèi)容就在這個(gè)文件里邊進(jìn)行編輯。

其中,如果需要網(wǎng)站的名字,在mkdocs.yml里邊將site_name:改為需要的名字即可。

剩下的內(nèi)容就變成markdown語(yǔ)法寫(xiě)文件就可以了。

運(yùn)行項(xiàng)目

mkdocs serve

發(fā)布

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)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

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

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