Editing This Guide¶
This guide uses MkDocs + Material for MkDocs ⧉. The markdown version is Python-Markdown. This page ⧉ contains the reference for the material theme. Install extra MkDocs plugins in build.gradle + mkdocs.yml.
If you are using IntelliJ for editing, it is recommended to install the plugin Grazie Professional ⧉ for spell-checking.
Editing¶
- The first header should be
#
. - Inserted images with Markdown, not HTML:
![description](url){width="600px"}
. Set the with to 600px or 300px, depending on how big or small the image is - footnotes syntax ⧉
- The
target=_blank
attribute and an icon for external links get automatically added to links.
The following symbols must be escaped:
- $ is
$
because it collides with inline Latex blocks.
Trees can be created with the terminal command tree
. It supports the -I
parameter for excluding folders.
Extensions¶
Besides the Material extensions, the project used the following Pymdown ⧉ extensions:
- pymdownx.betterem ⧉: different emphasis handling
- pymdownx.inlinehilite ⧉: inline code highlighting; example: #!js var test = 0;
- pymdownx.magiclink ⧉: linkafies URLs
- pymdownx.smartsymbols ⧉: inserts commonly used Unicode characters via ASCII representations.
- pymdownx.superfences ⧉: extension to Markdown fences
- pymdownx.details ⧉: collapsible elements
- pymdownx.highlight ⧉
- pymdownx.snippets ⧉: include other Markdown or HTML snippets into the current Markdown file
- pymdownx.keys ⧉: simplifies inserting key inputs; example: Ctrl+Alt+Del
- pymdownx.caret ⧉: superscript text via caret
- pymdownx.mark ⧉: enables marking words
- pymdownx.tilde ⧉: subscript text via tilde
- pymdownx.emoji: support for custom Emojis. Some example icons are in MPS Icons ⧉.
- pymdownx.tasklist ⧉: support for lists with checkboxes
- mk_in_html ⧉: support for Markdown in HTML
- pymdownx.magiclink ⧉: additional link-related features
- mdx-spanner ⧉: enables row and column spanning in Markdown tables
Macros¶
The plugin mkdocs-macros-plugin ⧉ is activated.
You can add variables to the extra section of mkdocs.yml (example: mps_latest
) and use the available macros:
- contribution_by(GitHub_username)
- question_by(GitHub_username)
- answer_by(GitHub_username)
- mps_url(identifier)
- image_popup()
- iets3()
- mbeddr()
- mbeddr_platform()
- mps_extensions()
- mps
Look through main.py to see how they are implemented.
The identifier can start with one of the following special identifiers:
The special identifiers get translated to the corresponding package names. Only the last part of the identifier has to be the correct name. The identifier can reference classes, interfaces, concepts, and interface declarations in Base Language, MPS Extensions ⧉, mbeddr, and iets3. The rest of the identifier only helps to find the correct node and doesn't have to be exact.
Example: @mps.ClassConcept
will find jetbrains.mps.baseLanguage.structure.ClassConcept
. When the wrong node is
selected, enter more parts of the full qualified name of the node.
Diagrams¶
Kroki enables support for diagrams (examples ⧉). It supports the following diagrams:
- BlockDiag ⧉
- BlockDiag ⧉ (simple block diagrams)
- SeqDiag ⧉ (simple sequence diagrams)
- ActDiag ⧉ (simple activity diagrams)
- NwDiag ⧉ (simple network diagrams)
- PacketDiag ⧉ (packet header diagrams)
- RackDiag ⧉ (rack diagrams)
- BPMN ⧉
- Bytefield ⧉
- C4 (with PlantUML) ⧉
- Ditaa ⧉
- Erd ⧉
- Excalidraw ⧉
- GraphViz ⧉
- Mermaid ⧉
- Nomnoml ⧉
- Pikchr ⧉
- PlantUML ⧉
- Structurizr ⧉
- SvgBob ⧉
- UMLet ⧉
- Vega ⧉
- Vega-Lite ⧉
- WaveDrom ⧉
They can be embedded by creating a code block and the text kroki-[diagramtype]
.
The following sections contain ideas for diagrams.
blockdiag¶ ⧉
Diagram 1¶
Diagram 2¶
SeqDiag¶ ⧉
ActDiag¶ ⧉
Graphviz¶ ⧉
Ditaa¶
mermaid.js¶ ⧉
nomnoml¶ ⧉
plantUML¶ ⧉
Diagram 1¶
Diagram 2¶
BPMN¶ ⧉
```
<?xml version="1.0" encoding="UTF-8"?>
Diagram 1¶
Diagram 2¶
BPMN¶ ⧉
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 |
|