windows上使用mkdocs搭建靜態部落格

標籤：啟動服務   style   nload   輸出   tin   技術   而且   定義   控制   

windows上使用mkdocs搭建靜態部落格

之前嘗試過用HEXO搭建靜態部落格，最近發現有個叫mkdocs的開源項目也是搭建靜態部落格的好選擇，而且它支援markdown格式，下面簡要介紹一下mkdocs的環境搭建過程

項目地址：https://github.com/mkdocs/mkdocs

介紹：英文版----http://www.mkdocs.org/

中文版----http://markdown-docs-zh.readthedocs.io/zh_CN/latest/

使用環境：win8.1  64位

基本配置

首先，通過pip安裝mkdocs

MkDocs 支援 Python 2.6, 2.7, 3.3 和 3.4

pip  install mkdocs

安裝後查看一下版本：

mkdocs  --version

添加路徑

找到mkdocs.exe，把它的路徑添加到環境變數中

在任意位置上建立一個專案檔夾，比如名為myproject

mkdocs  new  myproject

cd  myproject

專案檔夾下的檔案如下：

mkdocs.yml是設定檔,docs檔案夾下的名為index.md的檔案，當你啟動服務的時候就會顯示這個md檔案的內容。（感覺這個專案檔夾比hexo的簡單多了）

mkdocs包含了一個內建伺服器可以用來預覽當前文檔。將當前路徑切換到myproject下，輸入mkdocs  serve啟動服務

瀏覽器中輸入http://127.0.0.1:8000/並開啟

顯示：

常用的命令：

mkdocs  new  dirname ：建立項目

mkdocs   serve：開啟服務

mkdocs   build：構建檔案的網站

mkdocs  help：查看協助

如果需要自訂的頁面，可以修改mkdocs.yml的配置，其實mkdocs.yml的原始內容不多，也就一行：

site_name: My Docs

可以將My Docs修改成你想要的內容，然後重啟服務後的My Docs就會變成你輸入的內容了

添加頁面

首先，執行下面

curl ‘jaspervdj.be/lorem-markdownum/markdown.txt‘ > \mkdocs\myproject\docs\about.md

 

但是cmd上提示curl是無效的命令，額。。。先下載curl

點擊下面的連結：

https://curl.haxx.se/download.html

找到win64的並且尾碼為CAB的選項下載，解壓

找到AMD64檔案夾下，將curl.exe的路徑添加到環境變數

cmd上切換到AMD64目錄，試試curl --help，如果有正常的回複那麼就安裝完成了

執行前面原來失敗的步驟，再加個：

curl ‘jaspervdj.be/lorem-markdownum/markdown.txt‘ > \mkdocs\myproject\docs\more.md

執行完畢後在docs目錄下顯示了新產生的md檔案

如果需要為文檔添加導航條，只要在設定檔中添加需要的標題和排序：

site_name: My Docs

pages:

- [index.md, Home]

- [about.md, About]

- [more.md,More]

theme: readthedocs

重新整理瀏覽器即可看到 Home 和 About 還有More導覽列目

當然，你也可以切換主題，這裡我用到的是ReadTheDocs 主題

產生網站

cmd下輸入：

mkdocs build

此時會產生一個名為site的目錄

注意源碼被分別輸出為 index.html 和 about/index.html. 主題中的其他檔案也被複製到了 site 目錄中.

如果你使用 git 等版本控制系統, 你可能不希望提交構建之後的文檔到版本庫. 在 .gitignore 中添加 site/ 即可忽略該目錄.

 echo "site/" >> .gitignore

如果你使用其他版本控制系統則需要查閱相關文檔以確定如何忽略指定目錄.

一段時間後, 可能有檔案被從源碼中移除了, 但是相關的文檔仍殘留在 site 目錄中. 在構建命令中添加 --clean 參數即可移除這些文檔.

 mkdocs build –clean

發布

發行就緒到github.page，建立一個github的項目並在setting上做好相關設定就可以了

需要深入研究的話可以看前面放出的連結

Jekyll 是一個靜態網站產生器，和mkdocs一起協同工作可以搭建一個很好的部落格

可以參考：http://www.ruanyifeng.com/blog/2012/08/blogging_with_jekyll.html

windows上使用mkdocs搭建靜態部落格