UNPKG

docute

Version:

Effortlessly documentation done right.

github.com/leptosia/docute

leptosia/docute

40 lines (24 loc) • 1.62 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# 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/leptosia/docute/master)](https://circleci.com/gh/leptosia/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 Check out: https://docute.org Are you looking for the v3 docs? See [here](https://v3.docute.org). ## Resources - [Official Plugins](https://github.com/leptosia/docute-plugins) - [Awesome Docute](https://github.com/leptosia/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** © [Leptosia](https://github.com/leptosia), Released under the [MIT](./LICENSE) License.<br> Authored and maintained by EGOIST with help from contributors ([list](https://github.com/leptosia/docute/contributors)). > [github.com/leptosia](https://github.com/leptosia) · GitHub [@leptosia](https://github.com/leptosia) · Twitter [@leptosia](https://twitter.com/leptosia)