egoist/docute

JavaScriptdocute.egoist.dev

πŸ“š Effortless documentation, done right.

documentationgitbookdocutepr-welcomedocumentation-toolvue
Star Growth
Stars
3.8k
Forks
416
Weekly Growth
+-1
Issues
76
1k2k3k
Dec 2016Mar 2020Jul 2023Oct 2026
Artifactsnpm
README

ATTENTION: this project is no longer actively maintained (I still push some code once in a while), if you want to see improvements on this project, please consider sponsoring me.

Docute

npm version jsdelivr downloads circleci donate

Effortless documentation, done right.

Features

  • No build process, website is generated on the fly.
  • A simple yet elegant UI that is dedicated to documentation.
  • Leveraging the power of Markdown and Vue.
  • Extensible plugin system, plenty of official and community plugins.

Documentation

Resources

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

Author

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

Website Β· GitHub @EGOIST Β· Twitter @localhost_5173