mkdocs教程:http://www.mkdocs.org/#installation(英文)
html
http://markdown-docs-zh.readthedocs.org/zh_CN/latest/(中文)git
MacDown的下載包:http://yunpan.cn/cdmKrfvZs2fsc (提取碼:6a8e)github
開始學習mkdocs!!!
執行命令 sudo pip install mkdocs ,由於網速慢老是退出,報timeout錯
後在網絡上找到0.14.0的包直接裝也由於網絡的緣故暫停
提供的網址上 http://topmanopensource.iteye.com/blog/2004853 的教程裏提到命令 鏡像
pip install web.py -i http://pypi.douban.com/simple 速度超級快!
安裝完成後按照文檔教程裏開始學習啦!
在指定目錄下執行 mkdocs new my_pro 會生成一個目錄 其中包含-docs-index.md 和-mkdocs.yml
其中mkdocs.yml 中設置站點名稱 會自動顯示在網頁左上角和網頁標裏
index.md 裏按照既定好的格式來描寫文檔
生成好目錄以後 在mkdocs.yml同目錄下執行mkdocs serve 命令啓動內建服務器
而後修改docs/index.md文件中site_name,在保存的時候能夠觀察到網頁和shell裏面都在刷新
添加頁面
編輯index.md文件 修改標題,保存文件能夠看到網頁刷新
爲文檔添加第二個頁面,教程給到的命令格式是:curl 'index.md' > zzz.md 這個curl是在命令行方式下使用的開源文件傳輸工具,後面緊跟的是傳輸源文件 以後的文件是接受傳輸的文件,傳輸規則時若沒有則新建,若存在則覆蓋 。
文件新建好了以後須要加在網頁顯示,這時候在mkdocs.yml中須要添加一些內容了。
這樣的格式在保存後網頁會出現導航欄。web
配置主題
再配置主題,再在該文檔後添加 theme: readthdocs 保存後能夠看到瀏覽器主題的變化
site_name: MkLorum
pages:
- [index.md, Home]
- [about.md, About]
theme: readthdocs
站點生成
在mkdocs.yml的上一級目錄下執行mkdocs build,目錄下會新生成site目錄,
這個目錄在git提交的時候最好選擇ignore掉:echo 'site/' >> .ignore
教程文檔提醒 site目錄下, 源碼分別輸出爲index.html 和about/index.html
mkdocs build —clean 命令在有些文檔從源碼中移除後,在執行這個命令的時候能夠移除這些文檔
shell
以上是生成靜態文檔,接下來須要將文檔放在網絡上讓更多的人看到
http://www.ruanyifeng.com/blog/2012/08/blogging_with_jekyll.html
瀏覽器
該網址是jekyll的教程
Jekyll 是一個靜態網站生成器,接下來根據教程來學習:
http://lvxuedan.github.io/mkdoc_test/site/
git下的這個工程目錄
git init (對該目錄進行git初始化)
git checkout —orphan gh-pages (建立一個沒有父節點的分支gh-pages。由於github規定,只有該分支中的頁面,纔會生成網頁文件)
git add . (先把全部內容加入本地git庫)
git commit -m "first post」
git remote add origin https://github.com/username/jekyll_demo.git
git push origin gh-pages
服務器