add support for rednering mermaid diagrams

Signed-off-by: Maciej Pijanowski <[email protected]>
lpn-plant · Oct 21, 2022 · cd4a27f · cd4a27f
1 parent c9b8154
commit cd4a27f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/docs/FSM_state_diagrams_LPC.md b/docs/FSM_state_diagrams_LPC.md
@@ -1,6 +1,6 @@
 # Finite state machines for LPC peripheral and host
 
-### LPC Peripheral FSM state diagram:
+### LPC Peripheral FSM state diagram
 
 ```mermaid
 stateDiagram-v2
@@ -37,7 +37,7 @@ stateDiagram-v2
     LPC_ST_FINAL_TAR_CLK1 --> LPC_ST_FINAL_TAR_CLK2
     LPC_ST_FINAL_TAR_CLK2 --> LPC_ST_IDLE
 ```
-### LPC Host FSM state diagram:
+### LPC Host FSM state diagram
 
 ```mermaid
 stateDiagram-v2
@@ -78,4 +78,3 @@ stateDiagram-v2
     LPC_ST_FINAL_TAR_CLK1 --> LPC_ST_FINAL_TAR_CLK2
     LPC_ST_FINAL_TAR_CLK2 --> LPC_ST_FORCE_RESET
 ```
-
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -13,6 +13,12 @@ markdown_extensions:
   - pymdownx.superfences
   - pymdownx.keys
   - attr_list
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+
 nav:
   - 'About': index.md
   - 'How to':
@@ -36,4 +42,6 @@ nav:
   - 'TPM hardware interface documentation': tpm_lpc_spi_interface.md
   - 'SPI interface - implementation': tpm-spi-dev.md
   - 'SPI communication dump': tpm-spi-dump.md
-  - 'LPC driver - implementation': TPM_with_LPC_protocol.md
+  - 'LPC driver':
+     - 'LPC implementation': TPM_with_LPC_protocol.md
+     - 'State diagrams': FSM_state_diagrams_LPC.md