作为一个程序员,每天最多打交道的肯定是代码,其次就是各种开源框架的文档了,但是各个框架的文档都有它们自己的风格,在国内某些网站的打开速度也是堪忧,最重要的是:大部分文档都不支持搜索,也不支持中文,基于此,我开发了一个文档网站:https://www.docs4dev.com ,它使用了 ant-design 作为 UI 框架,不管是加载速度还是 UI 样式都十分美观;其次,它使用了
Elasticseach
作为文档搜索引擎,提供了快速准确的文档全文检索。最后,它还对文档做了简单的翻译,支持中文!
Features
- 支持的文档
- 支持多语言
- 英文
- 中文(beta)
- …
- 支持多版本的文档
- 良好的文档阅读体验
Doc4dev
基于ant-design
提供了非常简洁的文档阅读界面- 一键直接复制代码
- 基于
Elasticsearch
的文档全文检索
Contributing
文档翻译
如果你希望翻译相关的文档,请 clone
项目到本地,翻译完成后提交 PR。
目前文档的是按照以下结构进行分类的:
docs4dev/文档名称/版本号/语言代码/具体文档
目前我们只支持以下语言:
zh
: 中文en
: 英文
如果你希望翻译其它语言,请提 issue.
文档纠错
如果你发现某个文档和官方文档有出入,请提 issue.
其它
如果你有针对此网站好的建议或意见,也欢迎提 issue.
Roadmap
- 更多的文档和更多的文档版本支持
- …