Skip to content

Commit

Permalink
Add Mermaid diagram to documentation index
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
lipemorais committed Apr 1, 2024
1 parent e1e3daf commit 9970d78
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 9970d78

Please sign in to comment.