Mkdocs在html網頁上看markdown

2022-08-18 07:45:14 字數 2851 閱讀 4151

目錄4. 新增頁面

5. 總結

mkdocs是什麼?一句話概括如下

mkdocs 是乙個用於建立專案文件的快速,簡單,完美華麗的靜態站點生成器. 文件原始碼使用 markdown 來撰寫, 用乙個 yaml 檔案作為配置文件.

具體可以查mkdocs的官網

其介面如下圖所示

也可以檢視mkdocs的配置文件。

以上介紹的都很詳細了,紙上得來終覺淺,絕知此事要恭行。下面來詳細介紹一下基本的情況

安裝平台ubuntu16.04

在這裡,我們新建乙個mkdocs的工程

可以快速開始體驗

mkdocs serve
啟動伺服器自動的位址

如果想自定義乙個位址

可以輸入下面的位址

mkdocs serve --dev-addr=192.168.31.199:1666

或者mkdocs serve -a 127.0.0.1:9999

配置完成後,就可以啟動了

mkdocs 中乙個 markdown 文件渲染後就是乙個頁面,因此如果我們想新增乙個頁面,就需要先在 docs 目錄下新增乙個 markdown 檔案,檔案的字尾名可以是 md、markdown 、mdown、 mkdn 、mkd。

在docs目錄中新增test.md文件,並且專案檢視的結構

# 檢視專案結構

$ tree

.├── docs

│ ├── index.md

│ └── test.md

└── mkdocs.yml

site_name: 部落格系統

pages:

- 首頁: index.md

- 測試: test.md

theme: mkdocs 預設

theme: readthedocs

下面進行mkdocs主題切換

site_name: 測試部落格

page:

- home: index.md

- develoment: development.md

- about: about.md

theme: mkdocs

主題分為內建主題、第三方主題和自定義主題,內建主題如上所述,直接配置主題名就可以了;如果是第三方主題,就需要先安裝主題再進行配置了;自定義主題有點難度本文暫不介紹。

如果要將專案發布到**上,則需要生成靜態站點

mkdocs build
使用 mkdocs build –clean 可以在構建時清理一些殘留資源。

site 需要部署到 webserver 上才能正常執行。

發布的文件可以部署到任意的地方其中github project pages 和amazon s3 是不錯的選擇

對於專案的發布來說,需要構建文件,所以文件的建設十分的重要。一定要整理好文件,好記性不如爛筆頭,只有多做記錄和多些總結,才能進步成長。

在HTML網頁上列印需要的內容

首先在head裡面加入下面一段js function preview oper else 然後在所需要列印的 用和包圍著,如下 div id sty div 最後加上乙個列印的按鈕 input type button name button export title 列印 onclick previ...

在HTML網頁中巧用URL

首先,先放出乙個位址給大家測試 1,時下流行的 可能是吧,因為最近問的人比較多 就是沒有任何檔名的url位址。比如htmlpro 其實這和伺服器設定的預設檔名有關,比如index.htm,index.html,index.asp等等,不信你試試我朋友的乙個 asp的 2,本處的檔案為index.ht...

在HTML網頁中巧用URL

首先,先放出乙個位址給大家測試 1,時下流行的 可能是吧,因為最近問的人比較多 就是沒有任何檔名的url位址。比如htmlpro 其實這和伺服器設定的預設檔名有關,比如index.htm,index.html,index.asp等等,不信你試試我朋友的乙個 asp的 2,本處的檔案為index.ht...