-
-
Notifications
You must be signed in to change notification settings - Fork 7
/
mkdocs.yml
148 lines (141 loc) · 4.21 KB
/
mkdocs.yml
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
138
139
140
141
142
143
144
145
146
147
148
site_name: MkDocs Exporter
site_url: https://adrienbrignon.github.io/mkdocs-exporter
repo_url: https://github.com/adrienbrignon/mkdocs-exporter
repo_name: adrienbrignon/mkdocs-exporter
edit_uri: edit/master/docs/
site_dir: dist
validation:
absolute_links: ignore
unrecognized_links: ignore
anchors: ignore
theme:
name: material
custom_dir: overrides
icon:
logo: material/file-document-arrow-right
repo: fontawesome/brands/github
palette:
primary: custom
accent: custom
font:
text: Roboto
code: Roboto Mono
features:
- announce.dismiss
- content.action.edit
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.progress
- navigation.sections
- navigation.tabs
- navigation.top
- navigation.tracking
- navigation.prune
- toc.follow
extra:
social:
- name: GitHub
icon: fontawesome/brands/github
link: https://github.com/adrienbrignon/mkdocs-exporter
- name: PyPI
icon: fontawesome/brands/python
link: https://pypi.org/project/mkdocs-exporter
plugins:
- privacy:
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://installer.readthedocs.io/en/stable/objects.inv
options:
show_bases: false
show_source: true
show_labels: false
show_root_heading: true
- search:
lang: en
- awesome-pages
- macros:
include_dir: .
modules:
- macros
- git-revision-date-localized:
enable_creation_date: false
- redirects:
redirect_maps:
'index.md': 'getting-started.md'
- minify:
minify_html: true
- social:
cards_layout_options:
background_color: '#EA2027'
- git-committers:
repository: adrienbrignon/mkdocs-exporter
branch: master
- exporter:
logging:
level: debug
formats:
pdf:
enabled: !ENV [MKDOCS_EXPORTER_PDF, true]
concurrency: 16
stylesheets:
- resources/stylesheets/pdf.scss
covers:
front: resources/templates/covers/front.html.j2
back: resources/templates/covers/back.html.j2
browser:
debug: false
aggregator:
enabled: !ENV [MKDOCS_EXPORTER_PDF_AGGREGATOR, true]
output: documentation.pdf
covers: front
buttons:
- title: View as PDF
icon: material-file-move-outline
enabled: !!python/name:mkdocs_exporter.formats.pdf.buttons.download.enabled
attributes:
target: _blank
href: !!python/name:mkdocs_exporter.formats.pdf.buttons.download.href
- title: Download as PDF
icon: material-file-download-outline
enabled: !!python/name:mkdocs_exporter.formats.pdf.buttons.download.enabled
attributes: !!python/name:mkdocs_exporter.formats.pdf.buttons.download.attributes
markdown_extensions:
- admonition
- attr_list
- md_in_html
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- mdx_truly_sane_lists:
truly_sane: true
nested_indent: 2
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.arithmatex:
generic: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
extra_css:
- assets/stylesheets/custom.css
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.css
extra_javascript:
- assets/scripts/katex.js
- assets/scripts/mathjax.js
- assets/scripts/mkdocs-exporter.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/contrib/auto-render.min.js
- https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.2.2/es5/tex-mml-chtml.min.js
- https://cdnjs.cloudflare.com/ajax/libs/mermaid/10.9.1/mermaid.min.js