/docute

:scroll: Effortlessly documentation done right.

Primary LanguageJavaScriptMIT LicenseMIT

docute

Backers on Open Collective Sponsors on Open Collective NPM version NPM download Build Status donate

Special thanks to the generous sponsorship by:

Features

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

Quick Start

npm i -g docute-cli

docute init ./docs
docute

For detailed usage please head to https://docute.js.org ๐Ÿ˜Ž

Projects Using Docute

  • koel: ๐ŸŽต Music streaming app that works.
  • sao: โš”๏ธ Futuristic scaffolding tool.
  • service-mocker: ๐Ÿš€ The next generation front-end API mocking framework.
  • vuejs-component-style-guide: Vue component style guide
  • vue-scrollto: Vue scroll-to directive
  • Feel free to add yours here :)

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

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