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.
- finger-mover: A motion effect library that integrates Fingerd and Moved
- 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 @_egoistlily