|
|
The easiest way to work on the Wiki is to clone the repository and work in a text editor:
|
|
|
|
|
|
```bash
|
|
|
git clone https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/simulation.wiki.git
|
|
|
# For VSCode
|
|
|
code simulation.wiki
|
|
|
```
|
|
|
|
|
|
For new pages, make sure to link them **in both** `home.md` and `_sidebar.md`.
|
|
|
|
|
|
## Links
|
|
|
|
|
|
For links, the easiest way is to use absolute paths (since they can be copy-pasted on other pages without changes).
|
|
|
These look like this (example link to the 'Introduction to MontiSim' page and to an embedded graphic):
|
|
|
|
|
|
```markdown
|
|
|
[Introduction to MontiSim](/user-docs/Introcution-to-MontiSim)
|
|
|
|
|
|
![basic-simulator GUI](/user-docs/img/basic-sim-gui.png "Basic-simulator GUI.")
|
|
|
```
|
|
|
|
|
|
Note that the extension (`.md`) is omitted in links **to wiki pages**.
|
|
|
|
|
|
## File-names & headers
|
|
|
|
|
|
- Gitlab will use the **filename** of a page as title.
|
|
|
- Dashes (`-`) are replaced with spaces.
|
|
|
- The page title is equivalent to the level one header `#`, so use level two headers in the pages themselves (`##`). |