README.adoc 1.88 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
= New Bonita Documentation Site
// External URIs:
:url-antora: https://antora.org
:url-asciidoctor: https://asciidoctor.org/
:url-node: https://nodejs.org
:url-nvm: https://github.com/creationix/nvm
:url-nvm-install: {url-nvm}#installation


*_DISCLAIMER: this is a work in progress._*


== Architecture

Static site generation based on {url-antora}[Antora] using {url-asciidoctor}:[Asciidoctor] documentation content stored in various Git repositories.


== Build

=== Requirements


{url-node}[Node 12.x] (may work with newer versions, no guarantee). For more details, see the  https://docs.antora.org/antora/2.3/install-and-run-quickstart/[Antora installation guide].

While you can install Node from the official packages, we strongly recommend that you use {url-nvm}[nvm] (Node Version Manager) to install and manage Node.
Follow the {url-nvm-install}[nvm installation instructions] to set up nvm on your machine.

NOTE: all npm commands are intended to be run from the repository root folder.

=== Build the static site for production

Run
```bash
npm install
npm run build
```
The static site is then available in the `build/site` folder.


=== Local development

The `antora` CLI is available by calling `./node_modules/.bin/antora --version`

For more CLI options, see https://docs.antora.org/antora/2.3/cli/options/


==== Building for local developments

For a site that can be load from local disk
```bash
npm run local:build-static
```

For a site to be served by the development <<http server>>
```bash
npm run local:build
```


==== http server

Once the static site is build, you can run `npm run serve` and access to http://localhost:8080/ to check if everything is working correctly (urls in taxononmy, links, ....).

You can rebuild the site while the server is running, updated files are directly considered by the server (no cache).


== Documentation

See the xref:./docs/README[dedicated folder].