29 lines
684 B
Markdown
29 lines
684 B
Markdown
# Documentation Guidelines
|
|
|
|
Best practices and guidelines for writing code documentation.
|
|
|
|
## PlantUML
|
|
|
|
Create png images from PlantUML files using the following command:
|
|
|
|
```bash
|
|
plantuml -tpng <file>.puml
|
|
```
|
|
|
|
## Draw.io Diagrams
|
|
|
|
Ensure to have the draw.io application aliased. This example is for a macOS based system configured with ansible:
|
|
|
|
```yaml
|
|
- name: Add Draw.io alias to .zshrc
|
|
lineinfile:
|
|
path: "/Users/{{ macos_user }}/.zshrc"
|
|
line: "alias drawio='/Applications/draw.io.app/Contents/MacOS/draw.io'"
|
|
state: present
|
|
```
|
|
|
|
Create png images from Draw.io diagrams using the following command.
|
|
|
|
```bash
|
|
drawio -x -f png -b 10 -o <output>.png <file>.drawio
|
|
```
|