Source Code

Github: https://github.com/lisy09/dev-docs-template (opens new window)

This is a project to provide a toolbox/template and examples for easily creating the development documents.

Features

This project provides 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
• Support offlinify the static VuePress site so that can open through file:// access (do not support search yet)
• 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
• Also support Plantuml in .puml file and generated as image (png/svg) file (Recommended)
• Create more complicated diagrams & images by draw.io inside VSCode
• Several docs template

Easy to Start

# build all needed docker images
make all

# create a markdown file
echo '# Hello dev-docs-template' > docs_src/README.md

# build static html files
make html