docute

Special thanks to the generous sponsorship by:

Features

You don't need to run build process 👻
Simple yet powerful, benefit from Vue.js and our useful plugin API 💯
Easy for both beginners and pros 🙌
You can run code blocks in markdown files 💻
Very cute name 🤔

Quick Start

npm i -g docute-cli

docute init ./docs
docute

For detailed usage please head to https://docute.js.org 😎

Projects Using Docute

koel: 🎵 Music streaming app that works.
sao: ⚔️ Futuristic scaffolding tool.
service-mocker: 🚀 The next generation front-end API mocking framework.
vuejs-component-style-guide: Vue component style guide
vue-scrollto: Vue scroll-to directive
SAM Pattern (Korean): SAM Pattern docs in Korean
EverMonkey: VS Code Extension for Evernote.
Feel free to add yours here :)

Contributing

Fork it!
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request :D

Development

The development setup is basically webpack + vue:

cd docute
npm run dev
# then edit files in ./src dir and save to reload

Prior art

docute wouldn't exist if it wasn't for excellent prior art, docute is inspired by these projects:

Author

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

egoistian.com · GitHub @egoist · Twitter @rem_rin_rin