dev-docs-template
Origin: https://github.com/lisy09/dev-docs-template
This is a project to provide a toolbox/template and some samples for easily creating the development documents.
It provide these features:
- Major documents drafted in Markdown, generated as a single static html sites (with VuePress)
- Support export the document as a single pdf file
- Building the docs only depends on docker and Gnu Make
- Editing the docs depends on
- VSCode
- VSCode Remote Container Extension
- Docker engine
- PlantUML in Markdown for creating some diagram with UML
- Create more complicated diagrams & images by draw.io inside VSCode
- Several docs template
For further docs about this project, please check ./docs/index.html or https://lisy09.github.io/dev-docs-template/.