chungchi300/min-doc

What is min-doc

min-doc is an hackable simple documentation generation tool that support .md=>html and .plantuml=>img tool.

Advantage

Easy install - All you need is having node and npm installed
Easy editing - All you need is text editor like(nodepad++) to draw different graph and styling.
Good verision control - Because plantuml allow Easily create UML Diagrams(Flow chart,Sequence diagram,Class diagram) from simple textual description.
Github-like html style - Because when html generated from markdown using the github markdown css
hackable - Want to integrate with mindmap?Want to Write diagram inside markdown?Want to have .mp3 file?Simply Modify the generate.js file and create your own documentation generation tool.

Target User

User that are familar with markdown.Best markdown tutorial with online WYSIWYG Editior online
User that need to draw massive uml and diagram efficiently.What is Plantuml?

Usage

git clone git@github.com:chungchi300/min-doc.git yourProject
npm install
npm run build
/*
if you want to automatically generate file after editing.
npm run build-watch
*/

Example

Self
Demo

Optional Tool

Despite you can edit using any text editor,there is some plugins and editor suggested to use for real time preview & wysiwyg on single file

Editor

VS Code Studio

Plugins