diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 0a34a82216b6527d0dc7c9a72c4cfeff96885d59..95da7ec2beef3269e75624038e739993a22c8a3a 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -96,17 +96,54 @@ module.exports = { // nav: [ // { text: 'English', link: '/en/' } // ], - sidebar: { - "/": [ - "", - "/en/quickstart.md", - "/en/initializr.md", - "/en/installing.md", - "/en/system-requirements.md", - "/en/vscode_ide.md", - "/en/why-spring.md" - ] - } + sidebar: [{ + title: 'Spring Docs', // 必要的 + // path: '/', // 可选的, 标题的跳转链接，应为绝对路径且必须存在 + collapsable: false, // 可选的, 默认值是 true, + sidebarDepth: 1, // 可选的, 默认值是 1 + children: [ + '/en/' + ] + }, + { + title: 'INTRO', + sidebarDepth: 2, + collapsable: false, + children: [ + "/en/why-spring.md", + "/en/quickstart.md" + ], + initialOpenGroupIndex: 0 // 可选的, 默认值是 0 + }, + { + title: 'GUIDE', + sidebarDepth: 2, + collapsable: false, + children: [ + "/en/system-requirements.md", + "/en/installing.md" + ], + initialOpenGroupIndex: 0 // 可选的, 默认值是 0 + }, + { + title: 'IDE', + sidebarDepth: 2, + collapsable: false, + children: [ + "/en/vscode_ide.md" + ], + initialOpenGroupIndex: 0 // 可选的, 默认值是 0 + }, + { + title: 'DEMO', + sidebarDepth: 2, + collapsable: false, + children: [ + "/en/initializr.md" + ], + initialOpenGroupIndex: 0 // 可选的, 默认值是 0 + } + ] }, '/': { selectText: '选择语言', @@ -119,17 +156,63 @@ module.exports = { // nav: [ // { text: '中文文档', link: '/', ariaLabel: '中文文档' } // ], - sidebar: { - "/": [ - "", - "quickstart.md", - "initializr.md", - "installing.md", - "system-requirements.md", - "vscode_ide.md", - "why-spring.md" - ] - } + sidebar: [{ + title: 'Spring 文档', // 必要的 + // path: '/', // 可选的, 标题的跳转链接，应为绝对路径且必须存在 + collapsable: false, // 可选的, 默认值是 true, + sidebarDepth: 1, // 可选的, 默认值是 1 + children: [ + '/' + ] + }, + { + title: '介绍', + sidebarDepth: 2, + collapsable: false, + children: [ + "why-spring.md", + "quickstart.md" + ], + initialOpenGroupIndex: 0 // 可选的, 默认值是 0 + }, + { + title: '教程', + sidebarDepth: 2, + collapsable: false, + children: [ + "system-requirements.md", + "installing.md" + ], + initialOpenGroupIndex: 0 // 可选的, 默认值是 0 + }, + { + title: '编辑器', + sidebarDepth: 2, + collapsable: false, + children: [ + "vscode_ide.md" + ], + initialOpenGroupIndex: 0 // 可选的, 默认值是 0 + }, + { + title: '代码案例', + sidebarDepth: 2, + collapsable: false, + children: [ + "initializr.md" + ], + initialOpenGroupIndex: 0 // 可选的, 默认值是 0 + } + // "/": [ + // "", + // "quickstart.md", + // "initializr.md", + // "installing.md", + // "system-requirements.md", + // "vscode_ide.md", + // "why-spring.md" + // ] + ] } } } diff --git a/docs/README.md b/docs/README.md index b898c3c4f07242de0281addde45e087f9d15f2e2..d1b9d306e2c2a3e5808048d1779e6492a2e1a1ce 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,36 @@ -# Spring 社区 +# Spring 中文文档社区 -Spring 文档项目介绍 +从实操的角度整理翻译`Spring`相关文档，包括`快速开始`、`安装指南`、`开发工具配置`、`代码案例`等。 -## 参与建设奖励 +## 内容大纲 -## 参与建设流程 \ No newline at end of file +- 概述 +- 快速开始 +- 系统要求 +- 安装指南 +- 脚手架 +- VSCode +- IntelliJ IDEA +- 开发你的第一个 Spring Boot 应用程序 +- 构建 RESTful Web 服务 +- 使用 RESTful Web 服务 + +## 参与贡献 + +所有 **`Java Spring 熟练使用者`** 可以参与到`Spring 中文文档社区`的建设中来，选择自己感兴趣题目，可以直接撰写文章，也可以翻译 [Spring 官方](https://spring.io/) 上面的内容，也可以校对别人翻译的文章。具体贡献流程如下。 + +![](https://gitcode.net/zkxw2008/my-material/-/raw/master/spring/readme-1.png) + +1、Fork[此仓库](https://gitcode.net/dev-cloud/spring)到自己的[GitCode](https://gitcode.net/)账户下。 + +2、查看[Issue](https://gitcode.net/dev-cloud/spring/-/issues) 确定自己需要完成的题目。 + +3、对于已有中文的文档内容文件，可以执行校对。 + +4、对于暂时无中文文档内容的，可以直接贡献（翻译/撰写）原创中文文档。 + +5、内容完成者向[此仓库](https://gitcode.net/dev-cloud/spring)提交 PR（Pull Request）。 + +6、[此仓库](https://gitcode.net/dev-cloud/spring)审核人员审核通过，符合要求的，即会 Merge 到[此仓库](https://gitcode.net/dev-cloud/spring)中。 + +7、被 Merged 的 PR，会得到 200 ～ 500元不等的奖励。 diff --git a/docs/en/README.md b/docs/en/README.md index 501adabdd72fe447f1070feacd0a874d0be51822..d1b9d306e2c2a3e5808048d1779e6492a2e1a1ce 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -1 +1,36 @@ -# English Version \ No newline at end of file +# Spring 中文文档社区 + +从实操的角度整理翻译`Spring`相关文档，包括`快速开始`、`安装指南`、`开发工具配置`、`代码案例`等。 + +## 内容大纲 + +- 概述 +- 快速开始 +- 系统要求 +- 安装指南 +- 脚手架 +- VSCode +- IntelliJ IDEA +- 开发你的第一个 Spring Boot 应用程序 +- 构建 RESTful Web 服务 +- 使用 RESTful Web 服务 + +## 参与贡献 + +所有 **`Java Spring 熟练使用者`** 可以参与到`Spring 中文文档社区`的建设中来，选择自己感兴趣题目，可以直接撰写文章，也可以翻译 [Spring 官方](https://spring.io/) 上面的内容，也可以校对别人翻译的文章。具体贡献流程如下。 + +![](https://gitcode.net/zkxw2008/my-material/-/raw/master/spring/readme-1.png) + +1、Fork[此仓库](https://gitcode.net/dev-cloud/spring)到自己的[GitCode](https://gitcode.net/)账户下。 + +2、查看[Issue](https://gitcode.net/dev-cloud/spring/-/issues) 确定自己需要完成的题目。 + +3、对于已有中文的文档内容文件，可以执行校对。 + +4、对于暂时无中文文档内容的，可以直接贡献（翻译/撰写）原创中文文档。 + +5、内容完成者向[此仓库](https://gitcode.net/dev-cloud/spring)提交 PR（Pull Request）。 + +6、[此仓库](https://gitcode.net/dev-cloud/spring)审核人员审核通过，符合要求的，即会 Merge 到[此仓库](https://gitcode.net/dev-cloud/spring)中。 + +7、被 Merged 的 PR，会得到 200 ～ 500元不等的奖励。 diff --git a/docs/en/intellij_idea/spring_guide_new_project.png b/docs/en/intellij_idea/spring_guide_new_project.png new file mode 100644 index 0000000000000000000000000000000000000000..68579cd3537624d98a26d7c99681bd55729009b8 Binary files /dev/null and b/docs/en/intellij_idea/spring_guide_new_project.png differ diff --git a/docs/en/intellij_idea/spring_guide_select_gradle_file.png b/docs/en/intellij_idea/spring_guide_select_gradle_file.png new file mode 100644 index 0000000000000000000000000000000000000000..154ca13ec624d957ff5a495cbf031aa6954e2d52 Binary files /dev/null and b/docs/en/intellij_idea/spring_guide_select_gradle_file.png differ diff --git a/docs/en/intellij_idea/spring_guide_welcome_import.png b/docs/en/intellij_idea/spring_guide_welcome_import.png new file mode 100644 index 0000000000000000000000000000000000000000..88f5a586378ba1e3027dfb9bfaa92d9180b062e2 Binary files /dev/null and b/docs/en/intellij_idea/spring_guide_welcome_import.png differ diff --git a/docs/en/vscode_ide.md b/docs/en/vscode_ide.md index 3d818d07e52db310fa689e0b59bc2f15e357d953..52c9d84955fd4c875778de277fc64d57db14a189 100644 --- a/docs/en/vscode_ide.md +++ b/docs/en/vscode_ide.md @@ -28,11 +28,11 @@ $ git clone https://github.com/spring-guides/gs-rest-service.gitCOPY With IntelliJ IDEA up and running, click **Import Project** on the **Welcome Screen**, or **File | Open** on the main menu: -![spring_guide_welcome_import](./vscode_ide/spring_guide_welcome_import.png) +![spring_guide_welcome_import](./intellij-idea/spring_guide_welcome_import.png) In the pop-up dialog make sure to select either [Maven](https://spring.io/guides/gs/maven)'s **pom.xml** or [Gradle](https://spring.io/guides/gs/gradle)'s **build.gradle** file under the **complete** folder: -![spring_guide_select_gradle_file](./vscode_ide/spring_guide_select_gradle_file.png) +![spring_guide_select_gradle_file](./intellij-idea/spring_guide_select_gradle_file.png) IntelliJ IDEA will create a project with all the code from the guide ready to run. @@ -40,7 +40,7 @@ IntelliJ IDEA will create a project with all the code from the guide ready to ru In case you’d like to start with an empty project and copy-and-paste your way through the guide, create a new **Maven** or **Gradle** project in the **Project Wizard**: -![spring_guide_new_project](./vscode_ide/spring_guide_new_project.png) +![spring_guide_new_project](./intellij-idea/spring_guide_new_project.png) ## See Also diff --git a/docs/en/why-spring.md b/docs/en/why-spring.md index 5c853dba394ee643315d32f882f8a65b465f46b6..7786d3fade76bc408bce14484aafa5cb30088ed4 100644 --- a/docs/en/why-spring.md +++ b/docs/en/why-spring.md @@ -1,6 +1,6 @@ # Why Spring? -Spring makes programming Java quicker, easier, and safer for everybody. Spring’s focus on speed, simplicity, and productivity has made it the [world's most popular](https://snyk.io/blog/jvm-ecosystem-report-2018-platform-application/) Java framework. +Spring makes programming Java quicker, easier, and safer for everybody. Spring’s focus on speed, simplicity, and productivity has made it the [world's most popular](https://snyk.io/blog/jvm-ecosystem-report-2018-platform-application/) Java framework. ## Spring is everywhere diff --git a/docs/initializr.md b/docs/initializr.md index 979d876923862fe563aeb74c784c609a487dc1a5..b04740ee15144a6f0c6b2fef6ad77d54ceca0f76 100644 --- a/docs/initializr.md +++ b/docs/initializr.md @@ -1,4 +1,4 @@ -# Spring initializr 构建工程 +# Spring initializr 构建项目 ![2022-03-01-18-11-18](./initializr/2022-03-01-18-11-18.png) diff --git a/docs/intellij_idea/spring_guide_new_project.png b/docs/intellij_idea/spring_guide_new_project.png new file mode 100644 index 0000000000000000000000000000000000000000..68579cd3537624d98a26d7c99681bd55729009b8 Binary files /dev/null and b/docs/intellij_idea/spring_guide_new_project.png differ diff --git a/docs/intellij_idea/spring_guide_select_gradle_file.png b/docs/intellij_idea/spring_guide_select_gradle_file.png new file mode 100644 index 0000000000000000000000000000000000000000..154ca13ec624d957ff5a495cbf031aa6954e2d52 Binary files /dev/null and b/docs/intellij_idea/spring_guide_select_gradle_file.png differ diff --git a/docs/intellij_idea/spring_guide_welcome_import.png b/docs/intellij_idea/spring_guide_welcome_import.png new file mode 100644 index 0000000000000000000000000000000000000000..88f5a586378ba1e3027dfb9bfaa92d9180b062e2 Binary files /dev/null and b/docs/intellij_idea/spring_guide_welcome_import.png differ diff --git a/docs/vscode_ide.md b/docs/vscode_ide.md index 3a08c21bf8232d2093daf422d85a99be43c26410..709a73097f59e3e44c952a3563e7781152739be9 100644 --- a/docs/vscode_ide.md +++ b/docs/vscode_ide.md @@ -28,11 +28,11 @@ $ git clone https://github.com/spring-guides/gs-rest-service.git复制 在 IntelliJ IDEA 启动并运行后，单击**欢迎屏幕**上的**Import Project**或**File |** 在主菜单上**打开：** -![spring_guide_welcome_import](./vscode_ide/spring_guide_welcome_import.png) +![spring_guide_welcome_import](./intellij_idea/spring_guide_welcome_import.png) 在弹出对话框中，确保选择**完整**文件夹下的[Maven](https://spring.io/guides/gs/maven)的**pom.xml**或[Gradle](https://spring.io/guides/gs/gradle)的**build.gradle**文件： -![spring_guide_select_gradle_file](./vscode_ide/spring_guide_select_gradle_file.png) +![spring_guide_select_gradle_file](./intellij_idea/spring_guide_select_gradle_file.png) IntelliJ IDEA 将创建一个项目，其中包含准备运行的指南中的所有代码。 @@ -40,7 +40,7 @@ IntelliJ IDEA 将创建一个项目，其中包含准备运行的指南中的所 如果您想从一个空项目开始并通过指南复制粘贴，请在**项目向导中创建一个新的****Maven**或**Gradle**项目： -![spring_guide_new_project](./vscode_ide/spring_guide_new_project.png) +![spring_guide_new_project](./intellij_idea/spring_guide_new_project.png) ## 也可以看看 diff --git a/docs/why-spring.md b/docs/why-spring.md index f472c55b368807f442d876349dd9f042275eb7da..b33409003448de6f8ecf6f44129f2b89320c7664 100644 --- a/docs/why-spring.md +++ b/docs/why-spring.md @@ -1,28 +1,28 @@ -# 为什么是 Spring？ +# 为什么是Spring？ Spring 让每个人都可以更快、更轻松、更安全地编写 Java。Spring 对速度、简单性和生产力的关注使其成为[世界上最受欢迎的](https://snyk.io/blog/jvm-ecosystem-report-2018-platform-application/)Java 框架。 -## Spring 无处不在 +## Spring无处不在 Spring 的灵活库受到全世界开发人员的信赖。Spring 每天为数百万最终用户提供令人愉悦的体验——无论是[流媒体电视](https://medium.com/netflix-techblog/netflix-oss-and-spring-boot-coming-full-circle-4855947713a0),[网上购物](https://tech.target.com/2018/12/18/spring-feign.html)，或无数其他创新解决方案。Spring 也有来自所有科技巨头的贡献，包括阿里巴巴、亚马逊、谷歌、微软等。 -## 弹簧很灵活 +## Spring很灵活 Spring 灵活而全面的扩展集和第三方库让开发人员可以构建几乎任何可以想象的应用程序。Spring 框架的核心是[控制反转 (IoC)](https://en.wikipedia.org/wiki/Inversion_of_control)和[依赖注入 (DI)](https://en.wikipedia.org/wiki/Dependency_injection)特性为广泛的特性和功能集提供了基础。无论您是为 Web 构建安全、反应式、基于云的微服务，还是为企业构建复杂的流数据流，Spring 都有可以提供帮助的工具。 -## Spring 是生产力 +## Spring是生产力 [弹簧靴](https://spring.io/guides/gs/spring-boot/)改变您处理 Java 编程任务的方式，从根本上简化您的体验。Spring Boot 结合了应用程序上下文和自动配置的嵌入式 Web 服务器等必需品，[微服务](https://spring.io/microservices)发展小菜一碟。为了更快，您可以将 Spring Boot 与 Spring Cloud 丰富的支持库、服务器、模式和模板集相结合，以安全地将整个基于微服务的架构部署到[云](https://spring.io/cloud)，在创纪录的时间内。 -## Spring 来得很快 +## Spring来得很快 我们的工程师非常关心性能。使用 Spring，您会注意到默认情况下快速启动、快速关闭和优化执行。Spring 项目也越来越多地支持[反应式](https://spring.io/reactive)（非阻塞）编程模型，效率更高。开发人员的生产力是 Spring 的超能力。Spring Boot 可帮助开发人员轻松构建应用程序，并且比其他竞争范式更省力。嵌入式 Web 服务器、自动配置和“fat jars”可帮助您快速入门，创新如[Spring DevTools 中的 LiveReload](https://docs.spring.io/spring-boot/docs/current/reference/html/using-spring-boot.html#using-boot-devtools-livereload)意味着开发人员可以比以往更快地迭代。您甚至可以在几秒钟内启动一个新的 Spring 项目，Spring Initializr 位于[启动.spring.io](https://start.spring.io/). -## Spring 是安全的 +## Spring是安全的 -Spring 在快速、负责任地处理安全问题方面有着良好的记录。Spring 提交者与安全专家合作，修补和测试任何报告的漏洞。第三方依赖项也受到密切监控，并定期发布更新以帮助确保您的数据和应用程序尽可能安全。此外，[春季安全](https://spring.io/projects/spring-security)让您更轻松地与行业标准的安全方案集成，并提供默认安全的值得信赖的解决方案。 +Spring 在快速、负责任地处理安全问题方面有着良好的记录。Spring 提交者与安全专家合作，修补和测试任何报告的漏洞。第三方依赖项也受到密切监控，并定期发布更新以帮助确保您的数据和应用程序尽可能安全。此外，[Spring安全](https://spring.io/projects/spring-security)让您更轻松地与行业标准的安全方案集成，并提供默认安全的值得信赖的解决方案。 -## Spring 是支持的 +## Spring是支持的 这[Spring社区](https://spring.io/community)是巨大的、全球性的、多样化的，涵盖了所有年龄和能力的人，从完全的初学者到经验丰富的专业人士。无论您在旅途中的哪个阶段，都可以找到使您更上一层楼所需的支持和资源：[快速入门](https://spring.io/quickstart),[指南和教程](https://spring.io/guides),[视频](https://www.youtube.com/channel/UC7yfnfvEUlXUIfm8rGLwZdA),[聚会](https://spring.io/events),[支持](https://spring.io/support)，甚至是正式的[培训和认证](https://spring.io/training).