Code Monkey home page Code Monkey logo

composerdocs's Introduction

安装mkdocs

本地环境是vagrant管理下的ubuntu16,已经预装了python2.7,但需要自己装pip。   pip的安装参考这个文档。   用pip安装mkdocs并安装必要依赖:

pip install mkdocs  
pip install python-markdown-math

构建和本地调试

下载源文档,并构建:

git clone https://github.com/wbwangk/ComposerDocs.git
cd ComposerDocs
$ mkdocs build

下列命令会运行一个web服务将site目录下的内容代理到8000端口:

$ mkdocs serve  --dev-addr 192.168.16.103:8000

由于是在虚拟机中运行,而且不是NAT模式,所以需要加上--dev-addr参数确保绑定的IP不是默认的127.0.0.1。
在windows(宿主机)下打开浏览器访问地址192.168.16.103:8000就可以看到文档内容了。注意自己对index.md的修改内容是否生效。

提交到github

mkdocs支持直接发布到github pages。

$ mkdocs build
$ mkdocs gh-deploy
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /opt/ComposerDocs/site
INFO    -  Copying '/opt/ComposerDocs/site' to 'gh-pages' branch and pushing to GitHub.
Username for 'https://github.com': wbwangk
Password for 'https://[email protected]':
INFO    -  Your documentation should shortly be available at: https://wbwangk.github.io/ComposerDocs/

也就是直接把site目录发布到了同一个库的gh-pages分支,很方便。

查看结果

首先,到https://github.com/wbwangk/hyperledgerDocs/tree/gh-pages查看提交的结果。
然后到 https://wbwangk.github.io/hyperledgerDocs/ 去查看github pages解析后的结果。

脚本化

可以建一个脚本来减少反复输入命令(如1.sh),不过对bash脚本不熟悉,不会编写自动输入github账号和口令。

rm -rf ComposerDocs
git clone https://github.com/wbwangk/ComposerDocs
cd ComposerDocs
mkdocs build
mkdocs gh-deploy

mkdocs gh-deploy会提示输入github账号和口令。(fork到自己github账号下再运行上述脚本)

composerdocs's People

Contributors

wbwangk avatar

Watchers

James Cloos avatar Top John avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.