Introduction

dev-docs-template is a toolbox for creating development documents with minimal setup so that developers can focus on documentation.

How It Works

dev-docs-template is a project with all source codes needed to build an environment for documentation.

It packages the tools below needed to build/edit the documents into docker images or VSCode Remote Container:

• VuePress (opens new window): Static Site Generator (Markdown to html)
• PlantUML VSCode Extension and plantuml-server docker container: Provide PlantUML edit/preview/export function
• C4-PlantUML (opens new window): a plantuml library to combines the benefits of PlantUML (opens new window) and the C4 model (opens new window) for providing a simple way of describing and communicate software architectures – especially during up-front design sessions – with an intuitive language using open source and platform independent tools.
• Draw.io VSCode Extension: Provided complicated diagram edit feature within VSCode. Recommended to use the svg file (with suffix .drawio.svg) so that no export is needed.

Developers can write documents with Markdown, and then uses this toolbox to exported all markdown documents into a static html site. Also dev mode of VuePress can help to preview your document sites while documenting.

Advance

To modify the setting or use the full features of VuePress, please check official VuePress documents (opens new window).