Project documentation with Markdown.
modified to support search in Chinese.
Idea from ZhangXin's blog: http://wyqbailey.github.io/2015/08/13/make-mkdocs-support-chinese.html
Steps:
-
Change lunr.js to a modified clone from https://github.com/ming300/lunr.js
-
Modify generate_search_index in mkdocs/search.py, add ensure_ascii=False
return json.dumps(page_dicts, sort_keys=True,ensure_ascii=False, indent=4)
-
some Chinese text changes
-
Make it a pip module
Of cource, you need python installed to use mkdocs.
# uninstall OFFICIAL MkDocs first
pip uninstall mkdocs
# install from github
pip install git+https://github.com/wusixin/mkdocs.cn
# or, install from github zip archive, faster
pip install https://codeload.github.com/wusixin/mkdocs.cn/zip/master
see document from http://www.mkdocs.org