/docute

:scroll: Effortlessly documentation done right.

Primary LanguageJavaScriptMIT LicenseMIT

docute

NPM version NPM download Build Status donate

Features

  • You don't need to run build process 👻
  • Simple yet powerful, benefit from Vue.js and our useful plugin API 💯
  • Easy for both beginners and pros 🙌
  • Very cute name 🤔

Quick Start

npm i -g docute-cli

docute init ./docs
docute

For detailed usage please head to https://docute.js.org 😎

Projects Using Docute

  • sao: ⚔️ Futuristic scaffolding tool.
  • service-mocker: 🚀 The next generation front-end API mocking framework.
  • Feel free to add yours here :)

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Development

The development setup is basically webpack + vue:

cd docute
npm run dev
# then edit files in ./src dir and save to reload

Prior art

docute wouldn't exist if it wasn't for excellent prior art, docute is inspired by these projects:

Author

docute © EGOIST, Released under the MIT License.
Authored and maintained by EGOIST with help from contributors (list).

egoistian.com · GitHub @egoist · Twitter @rem_rin_rin