mkdocs-material/mkdocs.yml at master · https-quantumblockchainai-atlassian-net/mkdocs-material · GitHub

History

executable file

221 lines (210 loc) · 7.14 KB

Raw

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

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

# Permission is hereby granted, free of charge, to any person obtaining a copy

# of this software and associated documentation files (the "Software"), to

# deal in the Software without restriction, including without limitation the

# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

# sell copies of the Software, and to permit persons to whom the Software is

# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in

# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE

# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS

# IN THE SOFTWARE.

# Project information

site_name: Material for MkDocs

site_url: https://squidfunk.github.io/mkdocs-material/

site_author: Martin Donath

site_description: >-

Write your documentation in Markdown and create a professional static site in

minutes – searchable, customizable, for all devices

# Repository

repo_name: squidfunk/mkdocs-material

repo_url: https://github.com/squidfunk/mkdocs-material

# Copyright

# Configuration

theme:

custom_dir: material/.overrides

features:

# - announce.dismiss

- content.action.edit

- content.action.view

- content.code.annotate

- content.code.copy

# - content.tabs.link

- content.tooltips

# - header.autohide

# - navigation.expand

- navigation.footer

- navigation.indexes

# - navigation.instant

# - navigation.prune

- navigation.sections

- navigation.tabs

# - navigation.tabs.sticky

- navigation.top

- navigation.tracking

- search.highlight

- search.share

- search.suggest

- toc.follow

# - toc.integrate

palette:

- scheme: default

primary: indigo

accent: indigo

toggle:

icon: material/brightness-7

- scheme: slate

primary: indigo

accent: indigo

toggle:

icon: material/brightness-4

font:

text: Roboto

code: Roboto Mono

favicon: assets/favicon.png

icon:

logo: logo

# Plugins

plugins:

- search:

separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

- minify:

minify_html: true

# Customization

extra:

analytics:

provider: google

property: !ENV GOOGLE_ANALYTICS_KEY

social:

- icon: fontawesome/brands/github

link: https://github.com/squidfunk

- icon: fontawesome/brands/gitter

link: https://gitter.im/squidfunk/mkdocs-material

- icon: fontawesome/brands/docker

link: https://hub.docker.com/r/squidfunk/mkdocs-material/

- icon: fontawesome/brands/python

link: https://pypi.org/project/mkdocs-material/

- icon: fontawesome/brands/twitter

link: https://twitter.com/squidfunk

# Extensions

markdown_extensions:

- abbr

- admonition

- attr_list

- def_list

- footnotes

- md_in_html

- toc:

permalink: true

- pymdownx.arithmatex:

generic: true

- pymdownx.betterem:

smart_enable: all

- pymdownx.caret

- pymdownx.details

- pymdownx.emoji:

emoji_generator: !!python/name:materialx.emoji.to_svg

emoji_index: !!python/name:materialx.emoji.twemoji

- pymdownx.highlight:

anchor_linenums: true

- pymdownx.inlinehilite

- pymdownx.keys

- pymdownx.magiclink:

repo_url_shorthand: true

user: squidfunk

repo: mkdocs-material

- pymdownx.mark

- pymdownx.smartsymbols

- pymdownx.superfences:

custom_fences:

- name: mermaid

format: !!python/name:pymdownx.superfences.fence_code_format

- pymdownx.tabbed:

alternate_style: true

- pymdownx.tasklist:

custom_checkbox: true

- pymdownx.tilde

# Page tree

nav:

- Home: index.md

- Getting started:

- Installation: getting-started.md

- Creating your site: creating-your-site.md

- Publishing your site: publishing-your-site.md

- Customization: customization.md

- Browser support: browser-support.md

- Philosophy: philosophy.md

- Alternatives: alternatives.md

- License: license.md

- Bug reporting:

- bug-report/index.md

- Creating a reproduction: bug-report/reproduction.md

- Changelog:

- changelog/index.md

- How to upgrade: upgrade.md

- Setup:

- Changing the colors: setup/changing-the-colors.md

- Changing the fonts: setup/changing-the-fonts.md

- Changing the language: setup/changing-the-language.md

- Changing the logo and icons: setup/changing-the-logo-and-icons.md

- Ensuring data privacy: setup/ensuring-data-privacy.md

- Setting up navigation: setup/setting-up-navigation.md

- Setting up site search: setup/setting-up-site-search.md

- Setting up site analytics: setup/setting-up-site-analytics.md

- Setting up social cards: setup/setting-up-social-cards.md

- Setting up a blog: setup/setting-up-a-blog.md

- Setting up tags: setup/setting-up-tags.md

- Setting up versioning: setup/setting-up-versioning.md

- Setting up the header: setup/setting-up-the-header.md

- Setting up the footer: setup/setting-up-the-footer.md

- Adding a git repository: setup/adding-a-git-repository.md

- Adding a comment system: setup/adding-a-comment-system.md

- Building an optimized site: setup/building-an-optimized-site.md

- Building for offline usage: setup/building-for-offline-usage.md

- Extensions:

- setup/extensions/index.md

- Python Markdown: setup/extensions/python-markdown.md

- Python Markdown Extensions: setup/extensions/python-markdown-extensions.md

- Dependencies:

- setup/dependencies/image-processing.md

- Reference:

- reference/index.md

- Admonitions: reference/admonitions.md

- Annotations: reference/annotations.md

- Buttons: reference/buttons.md

- Code blocks: reference/code-blocks.md

- Content tabs: reference/content-tabs.md

- Data tables: reference/data-tables.md

- Diagrams: reference/diagrams.md

- Footnotes: reference/footnotes.md

- Formatting: reference/formatting.md

- Grids: reference/grids.md

- Icons, Emojis: reference/icons-emojis.md

- Images: reference/images.md

- Lists: reference/lists.md

- MathJax: reference/mathjax.md

- Tooltips: reference/tooltips.md

- Insiders:

- insiders/index.md

- Getting started:

- Installation: insiders/getting-started.md

- Changelog: insiders/changelog.md

- Blog:

- blog/index.md

- 2022:

- blog/posts/blog-support-just-landed.md

- blog/posts/chinese-search-support.md

- 2021:

- blog/posts/the-past-present-and-future.md

- blog/posts/excluding-content-from-search.md

- blog/posts/search-better-faster-smaller.md

mkdocs-material/mkdocs.yml at master · https-quantumblockchainai-atlassian-net/mkdocs-material · GitHub

Expand file tree

Breadcrumbs

mkdocs.yml

Latest commit

History

Breadcrumbs

mkdocs.yml

File metadata and controls