summaryrefslogtreecommitdiffstats
path: root/server/sonar-docs/static/README.md
blob: 4e3c36aa6a7c78b89c448abfda092a25511f2344 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
These three `*.NavigationTree.json` files control the navigation trees of the three versions of the documentation.

Each one contains a JSON array. Array elements may either be:

* a path string
* a node

**Nodes contain two elements:**
* title - string. This is the "parent" node name to be used in the navigation tree
* children - array of path strings

**Paths**
* begin with '/'
* end with '/'
* match the `url:` value of a page. 
* **do not** include the trailing `.md` in the file name

**What is the URL value of a page?**  
The url value can be implicitly defined by the document's path under the `pages` directory, or explicitly overridden by in the page metadata by setting `url: [path here]`.

Paths must always start and end with '/'. That includes:
* page metadata
* navigation tree files
* links between pages