Mkdocs Tutorial: http://www.mkdocs.org/#installation (US)
http://markdown-docs-zh.readthedocs.org/zh_CN/latest/(English)
Macdown Download Package: HTTP://YUNPAN.CN/CDMKRFVZS2FSC (Extract code: 6A8E)
start learning Mkdocs !!!
Execute the command sudo pip install Mkdocs, because the network slow always quit, reported timeout error
after found on the network 0.14.0 package directly installed also because of the Internet pause
provided URL on http:/ topmanopensource.iteye.com/blog/2004853 's tutorial mentions command mirroring
pip install web.py-i http://pypi.douban.com/simple The speed is super fast!
After the installation is complete, follow the documentation tutorial to start learning!
Executing mkdocs new My_pro in the specified directory will generate a directory containing-DOCS-INDEX.MD and-MKDOCS.YML
where the set site name in Mkdocs.yml automatically appears in the upper left corner of the Web page and in the Web page label
Index.md describes the document in a well-established format
Execute the mkdocs serve command in the MKDOCS.YML directory after generating the directory
and then modify the Docs/index.md file in site _name, you can observe when you save the page and the shell are in the refresh
add page
Edit index.md file Modify the title, save the file can see the page refresh
Add a second page for the document, The command format given by the tutorial is: Curl ' index.md ' > zzz.md This curl is an open source file Transfer tool that is used in command line mode, followed by the file after the transfer source file is the file that accepts the transfer, The transport rule is new if it is not present and overwritten if it exists. When the
file is new, it needs to be added to the Web page, and you need to add some content to the mkdocs.yml.
Such a format will appear in the navigation bar after the page is saved.
Configuring themes
After you configure the theme, and then add Theme:readthdocs after the document is saved, you can see the changes in the browser theme
Site_name:mklorum
Pages:
-[Index.md, Home]
-[About.md, about]
Theme:readthdocs
Site generation
The Mkdocs build is executed at the top level of the mkdocs.yml, and a new site directory is generated under the directory.
This directory is best chosen when git commits ignore: Echo ' site/' >>. Ignore
The tutorial document reminds the site directory that the source code is exported to index.html and about/index.html respectively.
Mkdocs Build-clean command After some documents have been removed from the source code, you can remove these documents when you execute this command.
The above is to generate a static document, the next need to put the document on the network for more people to see
Http://www.ruanyifeng.com/blog/2012/08/blogging_with_jekyll.html
This URL is Jekyll's tutorial
Jekyll is a static web site Builder, followed by tutorials to learn:
http://lvxuedan.github.io/mkdoc_test/site/
This project directory under Git
Git init (git initialization for this directory)
Git Checkout-orphan gh-pages (creates a branch gh-pages that does not have a parent node. Because GitHub rules that only pages in that branch will generate a Web page file)
git Add. (Add all the contents to the local git repository first)
Git commit-m "first post"
Git remote add Origin https://github.com/username/jekyll_demo.git
Git push Origin Gh-pages
Mkdocs and Jekyll creating a static web site