Giters

lingxiezfy / docs4dev

后端开发常用框架文档及中文翻译，包含 Spring 系列文档（Spring, Spring Boot, Spring Cloud, Spring Security, Spring Session），大数据（Apache Hive, HBase, Apache Flume），日志（Log4j2, Logback），Http Server（NGINX，Apache），Python，数据库（OpenTSDB，MySQL，PostgreSQL）等最新官方文档以及对应的中文翻译。

Home Page:https://www.docs4dev.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Docs4dev

https://www.docs4dev.com

  • 【2019双11】ALL IN CLoud 低至1折

  • 新增 PDF 文档下载功能，方便无法联外网的同学查看文档（目前只支持 Spring Boot 以及 Zookeeper，后续会添加更多文档，如有需要，请提 Issue，我尽量优先添加）。

  • 网站新增移动版，你可以直接关注以下微信公众号并回复关键字【文档】，或是直接在手机浏览器中打开 【 https://www.docs4dev.com/amp/ 】 即可通过手机浏览文档

image

项目背景

目前许多开源项目的文档，都只有英文版，这对于国内用户不太友好；虽然目前也有很多人翻译文档，但是工作量太大，导致文档的翻译不是很全，而且时效性较低，很多框架的文档都是较老的版本。基于此，我创建了这个项目，并建立了相关的网站 Docs4dev。我会使用爬虫从官方拉取最新版本的文档，并通过调用 翻译API 对文档进行初步翻译，以减少后续人工翻译的工作量。

但是，因个人的时间及精力有限，同时我还要维护网站，抓取文档，所以无法及时对所有文档进行一一进行校对，所以，希望你能够帮助我一起来完善文档（查看校对指南）。

最后，如果你觉得本项目对你有所帮助，希望点赞支持一下。

项目技术

目前网站是使用 Spring Boot 提供 API， Nextjs + antd + React Hooks 做服务端渲染的形式开发的。同时，因为网站的前端使用了很多 h5 特性，所以对于 IE 的支持不是很友好，所以推荐使用 Chrome 进行访问。

所用技术整理如下：

  • Rest API：Spring Boot
  • 服务端渲染：nextjs
  • UI 库： antd
  • 编程语言： typescript + java
  • 编辑器：
    • EasyMD
    • stackedit（Vue）
  • 文本对比：
    • diff
    • diff2html
  • 全文检索： Elasticsearch

参与贡献

  • 如果你希望参与校对，请阅读 校对指南。
  • 如果你希望添加某个文档，
  • 如果你发现了网站的 bug，
  • 如果你觉得网站有哪个可以改进的地方，
  • 如果你希望添加更多的工具，
  • 请给我提 issue 😄 。

Contributers

Github 用户：

其他

  • funbuilder
  • czs

网站更新日志

  • 2019-12-01 实现文档 PDF 下载（支持书签，支持多语言）
  • 2019-11-24 添加手机版 Docs4dev（使用 AMP 方式实现，加载速度更快且更省流量 🛩 ）
  • 2019-10-14 编辑器添加自动保存功能 (#10）
  • 2019-10-10 修复 GitHub 网站使用github 登录出错 (#9)
  • 2019-10-03 修复文档翻译错误 (#8)
  • 2019-08-09 修复网站 502 错误 (#5)
  • ...

Roadmap

  • 更多文档的支持
  • asciidoctor 格式支持
  • 移动端（小程序）的支持
  • ...

文档列表

Spring

名称 文档版本 语言
Spring Boot Reference 1.5.9.RELEASE English
Spring Boot 中文文档 1.5.9.RELEASE 中文
Spring Boot Reference 2.1.1.RELEASE English
Spring Boot 中文文档 2.1.1.RELEASE 中文
Spring Cloud Reference Edgware.SR5 English
Spring Cloud 中文文档 Edgware.SR5 中文
Spring Cloud Reference Finchley.SR2 English
Spring Cloud 中文文档 Finchley.SR2 中文
Spring Cloud Reference Greenwich.RELEASE English
Spring Cloud 中文文档 Greenwich.RELEASE 中文
Spring Batch Reference 3.0.x English
Spring Batch 中文文档 3.0.x 中文
Spring Batch Reference 4.1.x English
Spring Batch 中文文档 4.1.x 中文
Spring Session Reference 1.3.4.RELEASE English
Spring Session 中文文档 1.3.4.RELEASE 中文
Spring Session Reference 2.1.2.RELEASE English
Spring Session 中文文档 2.1.2.RELEASE 中文
Spring Security Reference 4.2.10.RELEASE English
Spring Security 中文文档 4.2.10.RELEASE 中文
Spring Security Reference 5.1.2.RELEASE English
Spring Security 中文文档 5.1.2.RELEASE 中文
Spring AMQP Reference 1.7.11.RELEASE English
Spring AMQP 中文文档 1.7.11.RELEASE 中文
Spring AMQP Reference 2.1.2.RELEASE English
Spring AMQP 中文文档 2.1.2.RELEASE 中文
Spring Framework Reference 4.3.21.RELEASE English
Spring Framework 中文文档 4.3.21.RELEASE 中文
Spring Framework Reference 5.1.3.RELEASE English
Spring Framework 中文文档 5.1.3.RELEASE 中文
Spring Data JDBC 1.0.5.RELEASE English
Spring Data JDBC 1.0.5.RELEASE 中文
Spring Data JPA 1.11.18.RELEASE English
Spring Data JPA 1.11.18.RELEASE 中文
Spring Data JPA 2.0.13.RELEASE English
Spring Data JPA 2.0.13.RELEASE 中文
Spring Data JPA 2.1.5.RELEASE English
Spring Data JPA 2.1.5.RELEASE 中文
Spring Data Redis 1.8.18.RELEASE English
Spring Data Redis 1.8.18.RELEASE 中文
Spring Data Redis 2.1.5.RELEASE English
Spring Data Redis 2.1.5.RELEASE 中文

Http Server

名称 文档版本 语言
Nginx current English
Nginx 中文文档 current 中文
Apache 2.4 English
Apache 中文文档 2.4 中文

Python

名称 文档版本 语言
Python 2.7.15 English
Python 中文文档 2.7.15 中文
Python 3.7.2rc1 English
Python 中文文档 3.7.2rc1 中文

Database

名称 文档版本 语言
MySql 5.7 English
MySql 中文文档 5.7 中文
PostgreSQL Documentation 10.7 English
PostgreSQL 中文文档 10.7 中文
PostgreSQL Documentation 11.2 English
PostgreSQL 中文文档 11.2 中文
OpenTSDB 2.3 English
OpenTSDB 中文文档 2.3 中文
Mongodb Manual v3.6 English
Mongodb 中文文档 v3.6 中文

Logging

名称 文档版本 语言
Log4j2 Manual 2.x English
Log4j2 中文文档 2.x 中文
Logback Manual 1.3.0-alpha4 English
Logback 中文文档 1.3.0-alpha4 中文

ORM

名称 文档版本 语言
Hibernate ORM User Guide 5.4 English
Hibernate ORM 用户指南 5.4 中文

Template engine

名称 文档版本 语言
Thymeleaf Tutorial 3.0 English
Thymeleaf 教程 3.0 中文
Apache FreeMarker Manual 2.3.28 English
Apache FreeMarker 中文手册 2.3.28 中文

Big Data

名称 文档版本 语言
Apache Flume User Guide 1.9.0 English
Apache Flume 用户指南 1.9.0 中文
Apache Hive Language Manual 3.1.1 English
Apache Hive 中文手册 3.1.1 中文

About

后端开发常用框架文档及中文翻译，包含 Spring 系列文档（Spring, Spring Boot, Spring Cloud, Spring Security, Spring Session），大数据（Apache Hive, HBase, Apache Flume），日志（Log4j2, Logback），Http Server（NGINX，Apache），Python，数据库（OpenTSDB，MySQL，PostgreSQL）等最新官方文档以及对应的中文翻译。

https://www.docs4dev.com/