https://github.com/hhstore/annotated-go-peach
peach 项目源码注解. peach 是使用 golang 开发的文档发布系统.
https://github.com/hhstore/annotated-go-peach
golang macaron peach
Last synced: 6 months ago
JSON representation
peach 项目源码注解. peach 是使用 golang 开发的文档发布系统.
- Host: GitHub
- URL: https://github.com/hhstore/annotated-go-peach
- Owner: hhstore
- License: mit
- Created: 2016-10-31T06:39:10.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-10-31T09:11:57.000Z (about 9 years ago)
- Last Synced: 2025-04-05T03:31:53.178Z (9 months ago)
- Topics: golang, macaron, peach
- Language: Go
- Homepage: https://peachdocs.org/
- Size: 25.1 MB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# annotated-go-peach
- 本项目对 peach 源码作详细注解.
- 可参考阅读笔记和提交记录阅读.
## peach 简介:
- [peach - github](https://github.com/peachdocs/peach)
- [peach - 官网介绍](https://peachdocs.org/)
- 官方说明: peach 是一款支持多语言、实时同步以及全文搜索功能的 Web 文档服务器.
- 使用 go 语言开发, 是 macaron 框架作者[Unknwon](https://github.com/Unknwon) 应用 macaron 的最佳实践.
- 特点: 源码结构组织良好, 代码很少, 且质量很高.
## peach 源码版本:
- [v0.9.2](./v0.9.2)
- 为当前最新 release 版本(且是第一个 release).
- 作者 release 频率不高.
## peach 源码结构:
```
-> % tree v0.9.2 -L 1
v0.9.2
├── README.md
├── bindata.sh
├── cmd # 项目次级入口
├── conf
├── models
├── modules
├── peach.go # 项目全局入口: main()
├── public
├── routers # 路由部分
└── templates # 模板文件
```
## 阅读建议:
- 阅读源码之前, 参考官方文档, 在本机运行起来, 方便和源码具体细节对照.
- 从 `peach.go` 入口文件读起. 自顶向下, 逐层阅读.