- Clone the repo:
git clone [email protected]:mycolorway/zhiren_api_doc.git
cd zhiren_api_doc
andbundle install
- Setup the server:
bundle exec middleman server
then openhttp://localhost:4567
- Edit markdown files under
source/includes/
- Use
bundle exec middleman build
to build - If add new doc file then add file name to includes section in the index.html.md
- Push or make a PR 🎉