00110000-one / tendata-javadoc

Tendata Java后端技术文档

Java 项目开发指南

本地运行

环境要求：

• python： 3.0+

1. 克隆项目

git clone https://github.com/lwpk110/tendata-javadoc.git

2. 初始化环境

项目预览需要安装 Python 环境来启动 server，强烈建议使用 Python 3.6+ 的版本。如果本地没有 Python 环境，也可以使用 Docker预览服务器 来启动。

2.1 本地初始化

安装依赖

pip install -r requirements.txt

2.2 使用 Docker 初始化

docker pull squidfunk/mkdocs-material

3. 预览

3.1 本地预览

mkdocs serve

3.2 使用 Docker 预览

uinx:

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Windows:

docker run --rm -it -p 8000:8000 -v "%cd%":/docs squidfunk/mkdocs-material

协作规范

文档使用 Markdown 编写，使用 mkdocs 配合 mkdocs-material 主题构建。

• form
• code
• pr