# 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.org
- v3 (legacy) docs: https://v3.docute.org

## 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.<br>
Authored and maintained by EGOIST with help from contributors ([list](https://github.com/egoist/docute/contributors)).

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