iuoon/docute

像 gitbook 之类的工具需要编译后发布，而 docute 让你直接写 markdown 文件作为文档来显示而不需要编译成 html 这一步，你的文档目录里只需要一个首页 index.html 和你的配置文件 config.js。 docute 会直接渲染这些 markdown 文件为一个单页应用。配合 github pages 发布到 ./docs 目录效果更佳，当然发布到任何地方都可以。 docute 的文档: https://docute.js.org/#/zh-Hans/ (基于 Vue) Github 项目：https://github.com/egoist/docute

ANOUNCEMENT: Docute v4 is currently under active development, you may check out our WIP new website. 😄

docute

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
• lass: Lass scaffolds a modern package boilerplate for node
• telegraf: 📡 Modern Telegram bot framework for Node.js
• Feel free to add yours here :)

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

Development

The development setup is basically webpack + vue:

cd docute
npm install
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:

• flatdoc
• docsify
• vue.js

Author

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

egoistian.com · GitHub @egoist · Twitter @_egoistlily