mkdocs-to-pdf/mkdocs.yml at develop · domWalters/mkdocs-to-pdf · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
---
repo_name: domWalters/mkdocs-to-pdf
repo_url: https://github.com/domWalters/mkdocs-to-pdf
site_author: Dominic Walters
site_dir: site/
site_name: mkdocs-to-pdf
site_url: https://mkdocs-to-pdf.readthedocs.io
copyright: Copyright &copy; 2025 Dom Walters, Hideyuki KATO

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  # Tooltips
  - abbr
  # Admonitions
  - admonition
  # Annotations, Buttons, Grids, Icons & Emojis, Images, Tooltips
  - attr_list
  # Footnotes
  - footnotes
  # Annotations, Grids, Images
  - md_in_html
  # Images
  - pymdownx.blocks.caption
  # Formatting
  - pymdownx.caret
  # Formatting
  - pymdownx.critic
  # Admonitions
  - pymdownx.details
  # Icons & Emojis
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  # Code Blocks
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  # Code Blocks
  - pymdownx.inlinehilite
  # Formatting
  - pymdownx.keys
  # Formatting
  - pymdownx.mark
  # Code Blocks, Tooltips
  - pymdownx.snippets
  # Admonitions, Annotations, Code Blocks, Content Tabs
  - pymdownx.superfences
  # Content Tabs
  - pymdownx.tabbed:
      alternate_style: true
  # Lists
  - pymdownx.tasklist:
      custom_checkbox: true
  # Formatting
  - pymdownx.tilde
  # Data Tables
  - tables
  - toc:
      permalink: true

nav:
  - Home: README.md
  - Installation: installation.md
  - Usage: usage.md
  - Examples:
      - examples/admonitions.md
      - examples/annotations.md
      - examples/basics.md
      - examples/blockquotes.md
      - examples/buttons.md
      - examples/cjk-fonts.md
      - examples/code-blocks.md
      - examples/content-tabs.md
      - examples/data-tables.md
      - examples/footnotes.md
      - examples/formatting.md
      - examples/grids.md
      - examples/icons-emojis.md
      - examples/images.md
      - examples/lists.md
      - examples/tooltips.md
  - Changelog: CHANGELOG.md
  - License: LICENSE.md
  - Stuff to Migrate: stuff-to-migrate.md

plugins:
  - minify:
      minify_html: true
  - search
  - to-pdf:
      cover_title: MkDocs to PDF
      cover_subtitle: An MkDocs plugin to create a PDF

theme:
  features:
    - content.code.copy
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    logo: fontawesome/solid/file-pdf
    repo: fontawesome/brands/github
  name: material
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference