1
1
= How to contribute to the reference manual
2
2
3
- The Spring Framework reference manual uses http://asciidoctor.org/[asciidoctor].
4
- This document describes how to contribute documentation updates.
3
+ The Spring Framework reference manual uses http://asciidoctor.org/[asciidoctor]. This
4
+ document describes how to contribute documentation updates.
5
5
6
6
== Building with Gradle
7
7
8
- You can build the documentation using Gradle using the `asciidoctor` task. For example, from
9
- the project root execute the following command:
8
+ You can build the documentation using Gradle using the `asciidoctor` task. For example,
9
+ from the project root execute the following command:
10
10
11
+ [indent=0]
12
+ ----
11
13
./gradlew asciidoctor
14
+ ----
12
15
13
16
The generated reference manual will then be available at `build/asciidoc/html5/index.html`.
14
17
@@ -22,9 +25,9 @@ http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/[Editing AsciiDoc
22
25
with Live Preview] document. Once you have done that, there are additional gems to
23
26
install to make it work (assuming that you are using http://livereload.com/[LiveReload]):
24
27
25
- [source ]
28
+ [indent=0 ]
26
29
----
27
- gem install guard-rspec guard-livereload
30
+ gem install guard-rspec guard-livereload
28
31
----
29
32
30
33
When running `guard start` within the `src/asciidoc/` folder, any changes to the
@@ -33,13 +36,13 @@ When running `guard start` within the `src/asciidoc/` folder, any changes to the
33
36
34
37
== Troubleshooting
35
38
36
- * If you are using LiveReload, make sure to select _Allow access to file
37
- URLs_ in the LiveEdit plugin options of your browser.
38
- * The icon used to enable _LiveReload_ can be a bit confusing. The dot is empty
39
- when it is disabled and full when the plugin is active. Make sure to enable it
40
- on the tab displaying the `index.html` file.
41
- * Ensure you are _not_ running `guard start` at all as two instances could not run
42
- at the same time. To exit a current session in a clean way, type `e` in the shell.
39
+ * If you are using LiveReload, make sure to select _Allow access to file URLs_ in the
40
+ LiveEdit plugin options of your browser.
41
+ * The icon used to enable _LiveReload_ can be a bit confusing. The dot is empty when it
42
+ is disabled and full when the plugin is active. Make sure to enable it on the tab
43
+ displaying the `index.html` file.
44
+ * Ensure you are _not_ running `guard start` at all as two instances could not run at the
45
+ same time. To exit a current session in a clean way, type `e` in the shell.
43
46
44
47
== Documentation Notes
45
48
0 commit comments