# PUML

**Repository Path**: carter65536/puml

## Basic Information

- **Project Name**: PUML
- **Description**: puml 的模板 方便 调用
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-13
- **Last Updated**: 2025-08-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 📁 PUML 模板仓库

> 集成各种 PlantUML 图表模板，帮助开发者**快速创建标准 UML 图表**。

---

## 📚 目录结构

| 图表类型 | 简介 | 入口 |
|----------|------|------|
| 🔄 **sequence** | 序列图，适合展示通信结构 | [📄 查看](./diagrams/sequence/sequence.md) |
| ⏱️ **timeing** | 时序图（定时图），适合 FPGA/时序分析 | [📄 查看](./diagrams/timeing/timeing.md) |
| 🧠 **mindmap** | 思维导图，支持 Markdown 导出 | [📄 查看](./diagrams/mindmap/mindmap.md) |
| 🏃 **activity** | 活动图（新语法，无需 Graphviz） | [📄 查看](./diagrams/activity/activity.md) |
| 🎯 **state** | 状态图，入门 UML 的起点 | [📄 查看](./diagrams/state/state.md) |
| 📊 **gantt** | 甘特图，项目管理利器 | [📄 查看](./diagrams/gantt/gantt.md) |
| 📦 **json** | JSON 可视化图（需标准格式） | [📄 查看](./diagrams/json/json.md) |
| 🧾 **yaml** | YAML 可视化图（适合 K8s/CI） | [📄 查看](./diagrams/yaml/yaml.md) |
| 🔍 **json_and_yaml** | JSON vs YAML 对比详解 | [📄 查看](./diagrams/json/json_and_yaml.md) |

---

### 🗂️ 目录树预览

```tree
puml/
├── 📁 diagrams/
│   ├── 🔄 sequence/
│   ├── ⏱️ timeing/
│   ├── 🏃 activity/
│   ├── 🎯 state/
│   ├── 📊 gantt/
│   ├── 🧠 mindmap/
│   ├── 📦 json/
│   ├── 🧾 yaml/
│   └── 🔧 custom/
├── 📁 scripts/
│   ├── 🪟 generate-all.bat
│   ├── 🐧 generate-all.sh
│   └── 🧹 clean.bat
├── 📁 config/
│   ├── 📦 plantuml.jar
│   ├── ⚙️ plantuml.config
│   └── 📊 graphviz/
├── 📁 docs/
│   ├── 📖 usage.md
│   ├── 📘 syntax-guide.md
│   └── 📂 examples/
└── 📄 README.md
```

---

## 🚀 快速开始

### 📥 克隆仓库

#### 📦 Gitee

```bash
git clone git@gitee.com:carter65536/puml.git
```

#### 🐙 GitHub（待上传）

---

### 📦 安装依赖

| 工具 | 说明 | 命令 |
|------|------|------|
| ☕ **Java** | 最低版本 Java 8 | `java -version` |
| 📊 **Graphviz** | 用于布局计算 | [官网下载](https://graphviz.org/download/) |

---

### ⚙️ 配置环境

#### 1. 配置 PlantUML JAR

将 `plantuml.jar` 放入 `config/` 目录。

#### 2. 配置 Graphviz 路径

| 系统 | 配置示例 |
|------|----------|
| 🪟 Windows | `-graphvizdot "C:/Program Files/Graphviz/bin/dot.exe"` |
| 🐧 Linux | `-graphvizdot "/usr/bin/dot"` |
| 🍎 macOS | `-graphvizdot "/usr/local/bin/dot"` |

---

## 🧪 使用指南

### 🎯 生成图表

| 场景 | 命令 |
|------|------|
| 📄 生成单个图 | `java -jar config/plantuml.jar -charset UTF-8 diagrams/sequence.puml` |
| 🔄 批量生成（Windows） | `.\scripts\generate-all.bat` |
| 🐧 批量生成（Linux/macOS） | `./scripts/generate-all.sh` |
| 🧹 清理生成文件（Windows） | `.\scripts\clean.bat` |

---

### 🧩 VSCode 插件使用

| 步骤 | 操作 |
|------|------|
| 🔌 安装插件 | `Ctrl+P` → `ext install plantuml` |
| ⚙️ 配置路径 | `Ctrl+,` → 搜索 `PlantUML` → 配置 JAR 和 dot 路径 |
| 👀 预览图表 | `Alt+D`（或 macOS 上 `Option+D`） |

---

### 🐳 Docker 使用

| 步骤 | 命令 |
|------|------|
| 📦 拉取镜像 | `docker pull plantuml/plantuml-server:jetty` |
| 🚀 启动容器 | `docker run -d -p 8080:8080 plantuml/plantuml-server:jetty` |
| 🌐 访问服务 | 打开 [http://localhost:8080/plantuml](http://localhost:8080/plantuml) |
| 🛑 停止容器 | `docker stop [CONTAINER_ID]` |
| 🗑️ 移除容器 | `docker rm [CONTAINER_ID]` |

---

## 📚 参考链接

- [📦 PlantUML 下载](https://plantuml.com/zh/download)
- [📘 PlantUML 快速入门](https://plantuml.com/zh/starting)

---

## 🤝 贡献指南

1. 🍴 Fork 仓库
2. 🌿 创建分支：`git checkout -b feature/new-template`
3. ✏️ 添加/修改模板
4. ✅ 提交：`git commit -am 'Add new template'`
5. 📤 推送：`git push origin feature/new-template`
6. 🔄 创建 Pull Request

---

## 📄 许可证

本项目采用 [GPL-3.0](LICENSE) 许可证。

---

### ✅ 图标说明（可保留或替换）

| 图标 | 含义 |
|------|------|
| 🔄 序列图 | 代表通信顺序 |
| ⏱️ 时序图 | 时间轴相关 |
| 🧠 思维导图 | 结构/脑图 |
| 🏃 活动图 | 流程/状态 |
| 🎯 状态图 | 状态机 |
| 📊 甘特图 | 项目管理 |
| 📦 JSON | 数据结构 |
| 🧾 YAML | 配置文件 |
| 🪟 Windows | Windows 系统 |
| 🐧 Linux | Linux 系统 |
| 🍎 macOS | macOS 系统 |
| 🐳 Docker | 容器化 |
| 🔌 VSCode | 编辑器插件 |
| 📖 文档 | 说明文档 |