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