# hello-doc

**Repository Path**: leafdaxian/hello-doc

## Basic Information

- **Project Name**: hello-doc
- **Description**: api文档生成器
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: osc
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2019-01-25
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# Hello doc


> Hello doc是一款快译通通过代码生成漂亮的api在线文档工具，支持java快速生成接口文档

运行demo：[demo](https://yoqu.gitee.io/hello-doc-demo)

## 文档

Link： [详细文档](https://yoqu.gitee.io/hello-doc/#/guide)


## 特性
* 支持markdown（包含flowchat流程图）
* 参数实体跳转
* java注解支持
* 菜单快速筛选
* 接口搜索
* 接口统计

## 待实现功能
- [ ] mock接口
- [ ] swagger配置文件转换为hello doc
- [ ] markdown功能增强时序图等功能
- [ ] 文档工具国际化支持
- [ ] 文档工具接入在线评论支持评论功能
- [ ] 文档导出为pdf和word格式



## 截图展示：

![demo3](docs/images/demo3.png)

![demo1](docs/images/demo1.png)


## 更新日志