Skip to content

Commit d5d2705

Browse files
committed
Add callouts markdown extension
This extension allows using the "GitHub alert"[1] syntax for admonitions. This is used to write admonitions in a way that are nicely rendered by GitHub too. [1] https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
1 parent 6aaa39d commit d5d2705

File tree

12 files changed

+12
-0
lines changed

12 files changed

+12
-0
lines changed

cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ markdown_extensions:
7171
- attr_list
7272
- def_list
7373
- footnotes
74+
- github-callouts
7475
- pymdownx.details
7576
- pymdownx.highlight:
7677
anchor_linenums: true

cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ dev-formatting = ["black == 25.1.0", "isort == 6.0.0"]
9494
dev-mkdocs = [
9595
"Markdown == 3.7",
9696
"black == 25.1.0",
97+
"markdown-callouts == 0.4.0",
9798
"mike == 2.1.3",
9899
"mkdocs-gen-files == 0.5.0",
99100
"mkdocs-literate-nav == 0.6.1",

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ markdown_extensions:
7171
- attr_list
7272
- def_list
7373
- footnotes
74+
- github-callouts
7475
- pymdownx.details
7576
- pymdownx.highlight:
7677
anchor_linenums: true

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ dev-formatting = ["black == 25.1.0", "isort == 6.0.0"]
5353
dev-mkdocs = [
5454
"Markdown == 3.7",
5555
"black == 25.1.0",
56+
"markdown-callouts == 0.4.0",
5657
"mike == 2.1.3",
5758
"mkdocs-gen-files == 0.5.0",
5859
"mkdocs-literate-nav == 0.6.1",

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ markdown_extensions:
7171
- attr_list
7272
- def_list
7373
- footnotes
74+
- github-callouts
7475
- pymdownx.details
7576
- pymdownx.highlight:
7677
anchor_linenums: true

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ dev-formatting = ["black == 25.1.0", "isort == 6.0.0"]
6464
dev-mkdocs = [
6565
"Markdown == 3.7",
6666
"black == 25.1.0",
67+
"markdown-callouts == 0.4.0",
6768
"mike == 2.1.3",
6869
"mkdocs-gen-files == 0.5.0",
6970
"mkdocs-literate-nav == 0.6.1",

tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ markdown_extensions:
7171
- attr_list
7272
- def_list
7373
- footnotes
74+
- github-callouts
7475
- pymdownx.details
7576
- pymdownx.highlight:
7677
anchor_linenums: true

tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ dev-formatting = ["black == 25.1.0", "isort == 6.0.0"]
5252
dev-mkdocs = [
5353
"Markdown == 3.7",
5454
"black == 25.1.0",
55+
"markdown-callouts == 0.4.0",
5556
"mike == 2.1.3",
5657
"mkdocs-gen-files == 0.5.0",
5758
"mkdocs-literate-nav == 0.6.1",

tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ markdown_extensions:
7171
- attr_list
7272
- def_list
7373
- footnotes
74+
- github-callouts
7475
- pymdownx.details
7576
- pymdownx.highlight:
7677
anchor_linenums: true

tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ dev-formatting = ["black == 25.1.0", "isort == 6.0.0"]
4949
dev-mkdocs = [
5050
"Markdown == 3.7",
5151
"black == 25.1.0",
52+
"markdown-callouts == 0.4.0",
5253
"mike == 2.1.3",
5354
"mkdocs-gen-files == 0.5.0",
5455
"mkdocs-literate-nav == 0.6.1",

0 commit comments

Comments
 (0)