-
Notifications
You must be signed in to change notification settings - Fork 25
/
mkdocs.yml
150 lines (129 loc) · 4.04 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
149
150
# MkDocs.yml
# The YAML configuration file defines the settings
# for the entire site, including where pages are found, layout, markdown extensions,
# plugins, additional css and javascript, and much more
#
# The configuration parameters listed below are some examples and explainations of
# what can be set, but is not all-encompassing. Please see the MkDocs online user
# guide for a full breakdown of configuration
# This setting is required, and should be a string that is
# used as the main title for the project documentation
site_name: ''
# The canonical URL of the site
# adds a link tag to the generated HTML header
site_url: https://example.com/
docs_dir: docs
# This will provide a link to the repository in the menu bar
repo_name: 'Github'
# This should be set to the link to the online repository that contains the site,
# most likely on Bitbucket
repo_url: https://github.com/Autodesk/XLB
# This should be the relative path from repo_url to the docs folder
# This parameter is used by some themes to provide an 'edit' link on each page of the site
# that takes the user to the markdown source on the repository
edit_uri: edit/master/docs/
watch:
- ./xlb/
# Can be used to add a meta tag to the HTML header
site_description: 'Documentation for project XLB'
# Sets the theme and theme configuration for the site
# See https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes for a list of themes
# that can be installed.
theme:
# Name of the theme
name: material
features:
- header.autohide
logo: assets/logo.svg
# Favicon
favicon: assets/logo.svg
# Directory containing theme customizations
# custom_dir: theme_customizations/
font:
text: Ubuntu
palette:
# Palette toggle for light mode
- scheme: default
primary: white grey
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
primary: red
toggle:
icon: material/brightness-4
name: Switch to light mode
# MkDocs uses the Python Markdown library to translate the markdown pages into HTML
# this configuration parameter allows for Python Markdown extensions to be added that
# customize how the markdown is formatted
markdown_extensions:
- extra
- admonition
- codehilite
- smarty
- pymdownx.superfences
- pymdownx.highlight
- markdown.extensions.attr_list
- markdown.extensions.def_list
- markdown.extensions.fenced_code
- markdown.extensions.footnotes
- markdown.extensions.tables
- markdown.extensions.toc
- pymdownx.arithmatex:
generic: true
- attr_list
- pymdownx.superfences
- pymdownx.highlight:
use_pygments: true
linenums: true
anchor_linenums: true
linenums_style: table
- pymdownx.snippets
- pymdownx.highlight
- pymdownx.inlinehilite
# MkDocs supports plugins written in Python to extend the functionality of the site
# This parameter contains a list of the MkDocs plugins to add to the site
plugins:
- search
- autolinks
- mkdocstrings:
handlers:
python:
options:
separate_signature: true
# - toc-sidebar
# - tooltipster-links
#theme:
# #name: readthedocs
# name: readthedocs
# navigation_depth: 4
# features:
# - content.code.annotate
# - navigation.instant
# - navigation.tracking
# - navigation.tabs
# - navigation.tabs.sticky
# - navigation.sections
# - navigation.expand
# - navigation.indexes
# - toc.integrate
#markdown_extensions:
# - pymdownx.arithmatex:
# generic: true
# - attr_list
# - pymdownx.superfences
# - pymdownx.highlight:
# use_pygments: true
# linenums: true
# anchor_linenums: true
# linenums_style: table
## - pymdownx.snippets
## - pymdownx.highlight
## - pymdownx.inlinehilite
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
nav:
- XLB's home: index.md