|
|
|
[[_TOC_]]
|
|
|
|
|
|
|
|
# Documentation location
|
|
|
|
Gitlab.com has some helpful information on [wiki-specific markdown](https://docs.gitlab.com/ee/user/markdown.html#wiki-specific-markdown)
|
|
|
|
|
|
|
|
## Sidebar
|
|
|
|
Unfortunately, their sidebar is automatically alphabetically sorted and doing page hierarchy doesn't work very well. So you can customize the sidebar by going to the [_sidebar.md file and editing it](https://git.commerce.gov/enterprise_applications/documentation/wikis/_sidebar/edit) as you would any other MD file.
|
|
|
|
|
|
|
|
## Visualizations
|
|
|
|
You can use mermaid for various visualizations.
|
|
|
|
* [Their documentation on flowcharts](https://mermaidjs.github.io/flowchart.html).
|
|
|
|
* [Their documentation on sequence diagrams](https://mermaidjs.github.io/sequenceDiagram.html).
|
|
|
|
* [Their documentation on gantt diagrams](https://mermaidjs.github.io/gantt.html).
|
|
|
|
|
|
|
|
In addition, for architectural diagrams, we are using PlantUML. See [gitlab's documentation](https://docs.gitlab.com/ee/administration/integration/plantuml.html#creating-diagrams) on how to use it. |
|
|
\ No newline at end of file |
|
|
|
In addition, for architectural diagrams, we are using PlantUML. See [gitlab's documentation](https://docs.gitlab.com/ee/administration/integration/plantuml.html#creating-diagrams) on how to use it.
|
|
|
|
|
|
|
|
## Tables of content
|
|
|
|
Want a sweet TOC that inherits the header organization you worked so hard on?
|
|
|
|
|
|
|
|
Wish it could be like the one on this page? It's super easy! See below:
|
|
|
|
```markdown
|
|
|
|
[[_TOC_]]
|
|
|
|
``` |
|
|
\ No newline at end of file |
