dev-docs-template

提供创建开发文档的工具箱/模板以及样例

快速上手 →

开箱即用

使用最简的配置即可开始集中文档写作。

基于VuePress

文档生成基于VuePress,可以使用一切VuePress可以的扩展。

丰富的图表支持

支持基于Plantuml或draw.io的图表编辑。

本项目致力于提供创建开发文档的工具箱/模板以及样例。

# 简单易用,开箱即用

# 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
1
2
3
4
5
6
7
8