Skip to content

Commit 565e314

Browse files
committed
docs(template): improve navigation in MkDocs configuration
Enable built-in navigation features (footer, indexes, sections) and replace section-index plugin with awesome-nav for better documentation structure. This enhances user experience with improved navigation capabilities and maintains consistency with modern MkDocs best practices.
1 parent ac54f26 commit 565e314

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

template/.config/copier/mkdocs.yaml.jinja

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ theme:
4040
- content.tooltips
4141
# - header.autohide
4242
# - navigation.expand
43-
# - navigation.footer
44-
# - navigation.indexes
43+
- navigation.footer
44+
- navigation.indexes
4545
- navigation.instant
4646
- navigation.instant.prefetch
4747
- navigation.instant.progress
4848
- navigation.path
4949
# - navigation.prune
50-
# - navigation.sections
50+
- navigation.sections
5151
- navigation.tabs
5252
- navigation.tabs.sticky
5353
- navigation.top
@@ -98,11 +98,11 @@ plugins:
9898
# typeset: # sponsors only
9999

100100
# ----------------- External plugins, schema provided by us ---------------- #
101+
awesome-nav:
101102
git-committers:
102103
enabled: !ENV [READTHEDOCS, CI, false]
103104
repository: "{{ github_user }}/{{ github_repo }}"
104105
branch: main
105-
section-index:
106106

107107
# ----------- External plugins, schema provided by our community ----------- #
108108
include-markdown:

0 commit comments

Comments
 (0)