From 9970d789148ce5362f30d91b13fdfa30077871db Mon Sep 17 00:00:00 2001 From: FeliPython Date: Sun, 31 Mar 2024 21:45:08 -0300 Subject: [PATCH] Add Mermaid diagram to documentation index Added a sequence diagram using Mermaid into the documentation index to illustrate clearer communication between Alice and Bob. Additionally, configured `pymdownx.superfences` in `mkdocs.yml` to support Mermaid custom fences for better diagram rendering. --- docs/index.md | 6 ++++++ mkdocs.yml | 6 +++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 6c67e4c..636233b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,6 +9,12 @@ [Presentation slides](https://docs.google.com/presentation/d/1Ajv9MYQQ011_Y4r1W4I6Y-6XP_faFF0317Zkn2XupMw/edit?usp=sharing) 📊 +```mermaid +sequenceDiagram + Alice ->> Bob: Hello Bob, how are you? +``` + + ## Introduction and Overview - 🎬 Lecture: Introduction to Django and Django Rest Framework, and overview of API development. diff --git a/mkdocs.yml b/mkdocs.yml index 7cf7e2b..788e0b1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -51,9 +51,13 @@ markdown_extensions: generic: true - footnotes - pymdownx.details - - pymdownx.superfences - pymdownx.mark - attr_list + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.emoji: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg