Skip to content

Commit e1943d5

Browse files
authored
Improve cookiecutter mkdocs configuration (#77)
- Sort mkdocs `markdown_extensions` - Add cross-reference for `typing-extensions` - Add copy and annotation features to code - Improve code blocks configuration - Support rendering keys
2 parents 0f3c130 + 1596a39 commit e1943d5

File tree

1 file changed

+10
-3
lines changed
  • cookiecutter/{{cookiecutter.github_repo_name}}

1 file changed

+10
-3
lines changed

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

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ theme:
2525
repo: fontawesome/brands/github
2626
custom_dir: docs/overrides
2727
features:
28+
- content.code.annotate
29+
- content.code.copy
2830
- navigation.instant
2931
- navigation.tabs
3032
- navigation.top
@@ -65,16 +67,20 @@ markdown_extensions:
6567
- admonition
6668
- attr_list
6769
- pymdownx.details
68-
- pymdownx.superfences
69-
- pymdownx.tasklist
70-
- pymdownx.tabbed
70+
- pymdownx.highlight:
71+
anchor_linenums: true
72+
line_spans: __span
73+
pygments_lang_class: true
74+
- pymdownx.keys
7175
- pymdownx.snippets:
7276
check_paths: true
7377
- pymdownx.superfences:
7478
custom_fences:
7579
- name: mermaid
7680
class: mermaid
7781
format: "!!python/name:pymdownx.superfences.fence_code_format"
82+
- pymdownx.tabbed
83+
- pymdownx.tasklist
7884
- toc:
7985
permalink: "¤"
8086

@@ -103,6 +109,7 @@ plugins:
103109
# TODO(cookiecutter): You might want to add other external references here
104110
# See https://mkdocstrings.github.io/python/usage/#import for details
105111
- https://docs.python.org/3/objects.inv
112+
- https://typing-extensions.readthedocs.io/en/stable/objects.inv
106113
- search
107114
- section-index
108115

0 commit comments

Comments
 (0)