Skip to content

Commit 20c6d0a

Browse files
authored
Merge pull request #3661 from embik/add-permalinks-docs
Configure hover permalink anchors for documentation
2 parents adc7380 + cff2fac commit 20c6d0a

File tree

1 file changed

+31
-26
lines changed

1 file changed

+31
-26
lines changed

docs/mkdocs.yml

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ repo_name: kcp-dev/kcp
44
site_url: https://docs.kcp.io/kcp/
55

66
# Site content
7-
docs_dir: 'content'
7+
docs_dir: "content"
88
# Where to generate
9-
site_dir: 'generated'
9+
site_dir: "generated"
1010

1111
theme:
1212
name: material
1313
language: en
1414
# Common files such as images, stylesheets, theme overrides
15-
custom_dir: 'overrides'
15+
custom_dir: "overrides"
1616
features:
1717
# Enable navigation section index pages, so we don't see Concepts > Concepts
1818
- navigation.indexes
@@ -29,27 +29,27 @@ theme:
2929
logo: logo.svg
3030
favicon: favicons/favicon.ico
3131
palette:
32-
# Palette toggle for automatic mode
33-
- media: "(prefers-color-scheme)"
34-
toggle:
35-
icon: material/brightness-auto
36-
name: Switch to light mode
32+
# Palette toggle for automatic mode
33+
- media: "(prefers-color-scheme)"
34+
toggle:
35+
icon: material/brightness-auto
36+
name: Switch to light mode
3737

38-
# Palette toggle for light mode
39-
- media: "(prefers-color-scheme: light)"
40-
scheme: default
41-
primary: white
42-
toggle:
43-
icon: material/brightness-7
44-
name: Switch to dark mode
38+
# Palette toggle for light mode
39+
- media: "(prefers-color-scheme: light)"
40+
scheme: default
41+
primary: white
42+
toggle:
43+
icon: material/brightness-7
44+
name: Switch to dark mode
4545

46-
# Palette toggle for dark mode
47-
- media: "(prefers-color-scheme: dark)"
48-
scheme: slate
49-
primary: black
50-
toggle:
51-
icon: material/brightness-4
52-
name: Switch to system preference
46+
# Palette toggle for dark mode
47+
- media: "(prefers-color-scheme: dark)"
48+
scheme: slate
49+
primary: black
50+
toggle:
51+
icon: material/brightness-4
52+
name: Switch to system preference
5353

5454
extra_css:
5555
- stylesheets/crd.css
@@ -75,8 +75,8 @@ plugins:
7575
- search
7676
# Use Jinja macros in .md files
7777
- macros:
78-
include_dir: 'overrides'
79-
module_name: 'main'
78+
include_dir: "overrides"
79+
module_name: "main"
8080
# Configure multiple language support
8181
- i18n:
8282
docs_structure: suffix
@@ -101,15 +101,20 @@ markdown_extensions:
101101
custom_fences:
102102
- name: mermaid
103103
class: mermaid
104-
format: !!python/name:pymdownx.superfences.fence_code_format
105-
# Inline code block highlighting
104+
format:
105+
!!python/name:pymdownx.superfences.fence_code_format # Inline code block highlighting
106+
107+
106108
- pymdownx.inlinehilite
107109
# Lets you embed content from another file
108110
- pymdownx.snippets
109111
# Arbitrary nesting of code/content blocks inside each other
110112
- pymdownx.superfences
111113
# Enable note/warning/etc. callouts
112114
- admonition
115+
# Add permalinks to all headlines
116+
- toc:
117+
permalink: true
113118

114119
# Live reload if any of these change when running 'mkdocs serve'
115120
watch:

0 commit comments

Comments
 (0)