Skip to content

basarat/docute

 
 

Repository files navigation

docute

NPM version Build Status donate

Quick Start

npm i -g docute-cli

docute init ./docs
docute

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

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

About

📜 Effortlessly documentation done right.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 93.6%
  • CSS 4.2%
  • HTML 2.2%