Skip to content

Commit

Permalink
Add the markdown-svgbob extension
Browse files Browse the repository at this point in the history
This extension allows documentation to include ASCII diagrams/graphs
that are rendered as SVG when the documentation is generated, giving a
nicer look to the diagrams/graphs while keeping the documents readable
in text form.

This is especially useful for docstrings, are they will be seen by users
in text form, but we still want to render them nicely.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
  • Loading branch information
llucax committed Nov 23, 2023
1 parent ead7fba commit a40be5c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ markdown_extensions:
- attr_list
- def_list
- footnotes
- markdown_svgbob:
min_char_width: 0
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ dev-mkdocs = [
"Markdown == 3.5.1",
"black == 23.10.1",
"frequenz-repo-config[lib] == 0.7.5",
"markdown-svgbob == 202112.1022",
"mike == 2.0.0",
"mkdocs-gen-files == 0.5.0",
"mkdocs-include-markdown-plugin == 6.0.4",
Expand Down

0 comments on commit a40be5c

Please sign in to comment.