1 Star 0 Fork 0

wenxuanjin / spring-framework

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
CONTRIBUTING-DOCUMENTATION.adoc 2.14 KB
一键复制 编辑 原始数据 按行查看 历史

How to contribute to the reference

The Spring Framework reference now uses asciidoctor. This document describes how to contribute documentation updates.

Building with Gradle

You can build the documentation using gradle using the reference task. For example, from the project root execute the following command:

./gradlew reference

the output will be available at spring-framework/build/reference/htmlsingle/index.html

Live editing

One of the nice features about using asciidoctor is the support for live editing.

You will find a Guardfile already present at spring-framework/src/asciidoc/Guardfile. Make sure first to follow the setup instructions within the Editing AsciiDoc with Live Preview document. Once you have done that, there are additional gems to install to make it work (assuming that you are using LiveReload):

gem install guard-rspec guard-livereload

When running guard start within the src/asciidoc/ folder, any changes to the src/asciidoc/index.adoc file will automatically be written at src/asciidoc/build/index.html.

Troubleshooting

  • If you are using LiveReload, make sure to select Allow access to file URLs in the LiveEdit plugin options of your browser.

  • The icon used to enable LiveReload can be a bit confusing. The dot is empty when it is disabled and full when the plugin is active. Make sure to enable it on the tab displaying the index.html file.

  • Ensure you are not running guard start at all as two instances could not run at the same time. To exit a current session in a clean way, just type e in the shell.

Documentation notes

Some notes on documentation

1
https://gitee.com/wenxuanjin/spring-framework.git
git@gitee.com:wenxuanjin/spring-framework.git
wenxuanjin
spring-framework
spring-framework
master

搜索帮助