Skip to content

Commit f91c545

Browse files
authored
Merge pull request #338 from bci-oss/task/ESMF-145-explain-how-to-build-antora-docs
Update antora description and link to the instruction #145
2 parents 29e145d + 32f675f commit f91c545

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,10 @@ code generators, validators etc.
3737
This document provides an overall overview of the SDK, and the concepts applied throughout it.
3838
Detailed documentation and concepts for each component can be found in the respective subfolders.
3939

40-
This repository contains a detailed developer documentation written in AsciiDoc. The source files
41-
(AsciiDoc) are located [here](documentation/developer-guide) and are built using
42-
[Antora](https://antora.org/) which generates the documentation as HTML files.
40+
This repository contains a detailed developer documentation written in AsciiDoc.
41+
The source files (AsciiDoc) are located [here](documentation/developer-guide) and are built using
42+
[Antora](https://antora.org/) which generates the documentation as HTML files. A site generated using Antora is self-contained and can be viewed entirely offline via a web browser without setting up a web server.
43+
To build the documentation locally, please check out and follow the instructions in [ESMF documentation repository](https://github.com/eclipse-esmf/eclipse-esmf.github.io).
4344

4445
## Getting help
4546

0 commit comments

Comments
 (0)