国精品产品一区,深夜福利视频一区二区,日韩av自拍,国产一区二区高清

MkDocs提供靜態(tài)網(wǎng)站生成功能，可以通過這款軟件幫助用戶快速生成個人網(wǎng)站，軟件提供很多主題內容，您可以自定義網(wǎng)站主題，可以自定義HTML樣式，大部分主題都是可以自己配置的，頁面通過Markdown編輯，現(xiàn)在所有Markdown頁面都包含在構建中，無論它們是否包含在導航配置中，導航現(xiàn)在可以包含到外部站點的鏈接，自動填充的導航現(xiàn)在將索引頁面排在頂部，換句話說，索引頁將被列為目錄的第一個子級，而所有其他文檔則按索引頁后的文件名按字母數(shù)字順序進行排序，提供一個新的url模板過濾器可以巧妙地確保所有L都相對于當前頁面！

MkDocs軟件功能

MkDocs是一種快速，簡單和徹頭徹尾的華麗是邁向建設項目文檔面向靜態(tài)網(wǎng)站生成器。文檔源文件使用Markdown編寫，并使用單個YAML配置文件進行配置。它的設計易于使用，并且可以通過第三方主題，插件和Markdown擴展進行擴展。

特征

從Markdown文件構建靜態(tài)HTML文件。

使用插件和Markdown擴展來增強MkDocs。

使用內置主題，第三方主題或創(chuàng)建自己的主題。

將文檔發(fā)布到可以提供靜態(tài)文件的任何位置。

MkDocs軟件特色

1、在任何地方托管

MkDocs構建完全靜態(tài)的HTML網(wǎng)站，您可以將其托管在GitHub頁面，Amazon S3或您選擇的任何其他位置。

2、偉大的主題可用

MkDocs提供了許多漂亮的主題。在內置主題之間進行選擇：mkdocs和readthedocs，選擇MkDocs主題Wiki頁面上列出的第三方主題之一，或構建自己的主題。

3、工作時預覽您的網(wǎng)站

內置的dev-允許您在編寫文檔時預覽文檔。每當您保存更改時，它甚至會自動重新加載并刷新瀏覽器。

4、易于定制

通過自定義主題和/或安裝一些插件，使您的項目文檔看起來像您想要的樣子。

MkDocs教程

入門

入門非常容易。

mkdocs new my-pject

cd my-pject

花一點時間查看為您創(chuàng)建的初始項目。

有一個名為的配置文件mkdocs.yml，一個名為的文件夾 docs將包含您的文檔源文件。現(xiàn)在，該docs 文件夾僅包含一個名為的文檔頁面index.md。

MkDocs帶有內置的開發(fā)，可讓您在處理文檔時對其進行預覽。確保您與mkdocs.yml 配置文件位于同一目錄中，通過運行以下mkdocs serve 命令來啟動：

http://127.0.0.1:8000/在瀏覽器中打開，您將看到默認的主頁顯示：

開發(fā)還支持自動重裝，并且只要配置文件，文檔目錄或主題目錄中的任何內容發(fā)生更改，都將重建您的文檔。

docs/index.md在您選擇的文本編輯器中打開文檔，將初始標題更改為MkLorum，保存您的更改。您的瀏覽器將自動重新加載，您應該立即看到更新的文檔。

現(xiàn)在嘗試編輯配置文件：mkdocs.yml。將site_name設置更改 為MkLorum并保存文件。

site_name: MkLorum

您的瀏覽器應立即重新加載，并且您會看到新的網(wǎng)站名稱生效

添加頁面

現(xiàn)在將第二頁添加到您的文檔中：

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

由于我們的文檔站點將包含一些導航標題，因此您可能需要編輯配置文件，并通過添加nav 設置在導航標題中添加有關每個頁面的順序，標題和嵌套的一些：

保存所做的更改，您現(xiàn)在將看到一個導航欄，其中帶有Home和的About 項目位于左側Search，而Previous，，以及Next項目位于右側。

嘗試菜單項，在頁面之間來回導航。點擊 Search。將出現(xiàn)一個搜索對話框，使您可以搜索任何頁面上的任何文本。請注意，搜索結果包括網(wǎng)站上搜索詞的所有出現(xiàn)，并直接鏈接到搜索詞出現(xiàn)的頁面部分。您可以毫不費力地完成所有工作！

主題化我們的文檔

現(xiàn)在更改配置文件，以通過更改主題來更改文檔的顯示方式。編輯mkdocs.yml文件并添加theme設置：

保存所做的更改，您將看到正在使用ReadTheDocs主題。

更改圖標圖標

默認情況下，MkDocs使用MkDocs圖標圖標。要使用其他圖標，請在中創(chuàng)建一個img子目錄，docs_dir將自定義favicon.ico文件復制到該目錄。MkDocs將自動檢測該文件并將其用作您的收藏夾圖標。

建立網(wǎng)站

很好看 您已經(jīng)準備好部署MkLorum 文檔的第一階段。首先構建文檔：

mkdocs build

這將創(chuàng)建一個名為的新目錄site。看一下目錄：

請注意，您的源文檔已作為兩個名為index.html和的HTML文件輸出 about/index.html。您還可以將其他各種媒體site作為文檔主題的一部分復制到目錄中。您甚至還有一個sap.xml文件和mkdocs/search_index.json。

如果您正在使用源代碼控制，例如，git您可能不想文檔庫在存儲庫中的構建。site/在.gitignore文件中添加一行 。

echo “site/” >> .gitignore

如果您使用的是其他源代碼控制工具，則需要查看其有關如何忽略特定目錄的文檔。

一段時間后，文件可能會從文檔中刪除，但仍將保留在site目錄中。要刪除這些過時的文件，只需mkdocs 使用該–clean開關即可運行。

mkdocs build –clean

其他命令和選項

還有其他各種命令和選項。有關命令的完整列表，請使用–標志：

mkdocs —

要查看給定命令可用的選項列表，請將該–標志與該命令一起使用。例如，要獲取該build命令可用的所有選項的列表，請 運行以下命令：

mkdocs build —