From cd4a27fc0c4f5f5cf49786b47615bfd2c28d43b2 Mon Sep 17 00:00:00 2001 From: Maciej Pijanowski Date: Fri, 21 Oct 2022 09:37:41 +0200 Subject: [PATCH] add support for rednering mermaid diagrams Signed-off-by: Maciej Pijanowski --- docs/FSM_state_diagrams_LPC.md | 5 ++--- mkdocs.yml | 10 +++++++++- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/FSM_state_diagrams_LPC.md b/docs/FSM_state_diagrams_LPC.md index d62cc9d..4efb3ac 100644 --- 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 index ea5ae6e..98ecf02 100644 --- 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