egoist/docute

πŸ“š Effortless documentation, done right.

JavaScript

3,802

251 commits

updated Sep 25, 2023

See the code

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

documentation
documentation-tool
docute
gitbook
pr-welcome
vue

egoist/docute

πŸ“š Effortless documentation, done right.

JavaScript

3,802

251 commits

updated Sep 25, 2023

See the code

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

documentation
documentation-tool
docute
gitbook
pr-welcome
vue

Project health

Overall

2.1/10

Maintained

0/10

Code review

1/10
OpenSSF Scorecard

Latest release

4.23.3 Β· Oct 3, 2019

Releases this year

0

Significant stargazers

Evan You

111,745 followers Β· starred May 2017

hoijui

106 followers Β· starred Oct 2019

cinwell.li

1,707 followers Β· starred Mar 2019

Shawn Yang

1,971 followers Β· starred Dec 2023