this_doc.md 813 Bytes
Newer Older
1
About this documentation
2
3
========

4
## `docsify.js`
5

6
This markdown based documentation is made available in a nice way using [`docsify`](https://docsify.js.org/).
7
8


9
## Source
10

11
The source of the documentation is available in the `documentation` folder from the root of the repository.
12
13


14
## Rendering
15

16
The documentation is automatically rendered locally when you run the `make up` command. It is then available on [http://localhost:5000](http://localhost:5000).
17

Florent Chehab's avatar
Florent Chehab committed
18
To generate or update the UML diagrams, you need to run the command (from the root of the repository): `make documentation`.
19

20
## Issues ?
21

22
!> If the `search` functionality is not working after you have updated the documentation, it might be because the `localStorage` is not up to to data. You can empty it from your browser developer settings (`F12`).