https://github.com/egoist/docute

📚 Effortless documentation, done right.
https://github.com/egoist/docute

documentation documentation-tool docute gitbook pr-welcome vue

Last synced: 7 months ago
JSON representation

📚 Effortless documentation, done right.

• Host: GitHub
• URL: https://github.com/egoist/docute
• Owner: egoist
• License: mit
• Created: 2016-12-08T18:04:40.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-09-25T09:19:06.000Z (about 2 years ago)
• Last Synced: 2024-10-29T15:10:56.457Z (about 1 year ago)
• Topics: documentation, documentation-tool, docute, gitbook, pr-welcome, vue
• Language: JavaScript
• Homepage: https://docute.egoist.dev
• Size: 3.03 MB
• Stars: 3,805
• Watchers: 54
• Forks: 428
• Open Issues: 100
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-nodejs - docute - Effortless documentation, done right.  (Repository / Documentation)
• awesome-list - docute
• awesome-open-source-systems - Docute - Effortless documentation, done right. (Documentation Builder / Follow me)
• starred-awesome - docute - :scroll: Effortlessly documentation done right. (Vue)
• awesome - egoist/docute - 📚 Effortless documentation, done right. (JavaScript)
• awesome - egoist/docute - 📚 Effortless documentation, done right. (JavaScript)
• jimsghstars - egoist/docute - 📚 Effortless documentation, done right. (JavaScript)
• awesome - docute - 📚 Effortless documentation, done right. (JavaScript)
• awesome-starred - egoist/docute - 📚 Effortless documentation, done right. (documentation)
• awesome-hacking-lists - egoist/docute - 📚 Effortless documentation, done right. (JavaScript)

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](https://github.com/sponsors/egoist).

# Docute

[![npm version](https://badgen.net/npm/v/docute)](https://npm.im/docute) [![jsdelivr downloads](https://data.jsdelivr.com/v1/package/npm/docute/badge?style=rounded)](https://www.jsdelivr.com/package/npm/docute) [![circleci](https://badgen.net/circleci/github/egoist/docute/master)](https://circleci.com/gh/egoist/docute/tree/master)  [![donate](https://badgen.net/badge/support%20me/donate/ff69b4)](https://patreon.com/egoist)

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

- **v4 (latest) docs**: https://docute.egoist.dev

- v3 (legacy) docs: https://docute3.egoist.dev

## Resources

- [Official Plugins](https://github.com/egoist/docute-plugins)

- [Awesome Docute](https://github.com/egoist/awesome-docute)

## 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](https://github.com/egoist), Released under the [MIT](./LICENSE) License.


Authored and maintained by EGOIST with help from contributors ([list](https://github.com/egoist/docute/contributors)).

> [Website](https://egoist.dev) · GitHub [@EGOIST](https://github.com/egoist) · Twitter [@localhost_5173](https://twitter.com/localhost_5173)