1
- = How to contribute to the reference manual
1
+ = How to Contribute to the Reference Manual
2
2
3
3
The Spring Framework reference manual uses http://asciidoctor.org/[asciidoctor]. This
4
4
document describes how to contribute documentation updates.
@@ -13,14 +13,16 @@ from the project root execute the following command:
13
13
./gradlew asciidoctor
14
14
----
15
15
16
- The generated reference manual will then be available at `build/asciidoc/html5/index.html`.
16
+ The generated reference manual will then be available at
17
+ `build/asciidoc/html5/index.html`.
17
18
18
19
== Live Editing
19
20
20
- One of the nice features about using asciidoctor is the support for live editing.
21
+ One of the nice features about using Asciidoctor is the support for live editing.
21
22
22
- You will find a Guardfile already present at `spring-framework/src/asciidoc/Guardfile`.
23
- Make sure first to follow the setup instructions within the
23
+ You will find a Guardfile already present at
24
+ `spring-framework/src/docs/asciidoc/Guardfile`. First, follow the setup instructions
25
+ within the
24
26
http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/[Editing AsciiDoc
25
27
with Live Preview] document. Once you have done that, there are additional gems to
26
28
install to make it work (assuming that you are using http://livereload.com/[LiveReload]):
@@ -31,26 +33,28 @@ install to make it work (assuming that you are using http://livereload.com/[Live
31
33
----
32
34
33
35
When running `guard start` within the `src/asciidoc/` folder, any changes to the
34
- `src/asciidoc/index.adoc` file will automatically be written to
36
+ `src/asciidoc/index.adoc` file are automatically written to
35
37
`src/asciidoc/build/index.html`.
36
38
37
39
== Troubleshooting
38
40
39
- * If you are using LiveReload, make sure to select _Allow access to file URLs_ in the
41
+ * If you are using LiveReload, select _Allow access to file URLs_ in the
40
42
LiveEdit plugin options of your browser.
41
43
* The icon used to enable _LiveReload_ can be a bit confusing. The dot is empty when it
42
44
is disabled and full when the plugin is active. Make sure to enable it on the tab
43
45
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.
46
+ * Ensure you are _not_ running `guard start` at all, as two instances could not run at
47
+ the same time. To exit a current session in a clean way, type `e` in the shell.
46
48
47
49
== Documentation Notes
48
50
49
51
Some notes on the documentation.
50
52
51
- * Documentation is wrapped at 90 chars; ensure that you manually wrap your edits.
52
- * Tabs are used for indentation; do not use spaces.
53
+ * Documentation is wrapped at 90 chars. Ensure that you manually wrap your edits.
54
+ * Tabs are used for indentation. Do not use spaces.
53
55
* Follow the existing style when inserting `source` blocks.
56
+
57
+ Here are some useful resources for working with Asciidoctor:
54
58
* http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[Asciidoctor Quick Reference]
55
59
* http://asciidoctor.org/docs/user-manual/[Asciidoctor Manual]
56
60
* http://asciidoctor.org/docs/asciidoc-writers-guide/[Asciidoctor Writers Guide]
0 commit comments