@@ -5,24 +5,30 @@ 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
15
- == Live editing
18
+ == Live Editing
16
19
17
20
One of the nice features about using asciidoctor is the support for live editing.
18
21
19
22
You will find a Guardfile already present at `spring-framework/src/asciidoc/Guardfile`.
20
23
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]):
24
+ http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/[Editing AsciiDoc
25
+ with Live Preview] document. Once you have done that, there are additional gems to
26
+ install to make it work (assuming that you are using http://livereload.com/[LiveReload]):
24
27
28
+ [indent=0]
29
+ ----
25
30
gem install guard-rspec guard-livereload
31
+ ----
26
32
27
33
When running `guard start` within the `src/asciidoc/` folder, any changes to the
28
34
`src/asciidoc/index.adoc` file will automatically be written to
@@ -31,21 +37,20 @@ When running `guard start` within the `src/asciidoc/` folder, any changes to the
31
37
== Troubleshooting
32
38
33
39
* 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.
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.
40
46
41
- == Documentation notes
47
+ == Documentation Notes
42
48
43
- Some notes on documentation
49
+ Some notes on the documentation.
44
50
45
51
* Documentation is wrapped at 90 chars; ensure that you manually wrap your edits.
46
52
* Tabs are used for indentation; do not use spaces.
47
53
* Follow the existing style when inserting `source` blocks.
48
54
* http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[Asciidoctor Quick Reference]
49
55
* http://asciidoctor.org/docs/user-manual/[Asciidoctor Manual]
50
56
* http://asciidoctor.org/docs/asciidoc-writers-guide/[Asciidoctor Writers Guide]
51
-
0 commit comments