MCPcopy Index your code
hub / github.com/squidfunk/mkdocs-material

github.com/squidfunk/mkdocs-material @9.7.6 sqlite

repository ↗ · DeepWiki ↗ · release 9.7.6 ↗
2,165 symbols 7,678 edges 325 files 293 documented · 14%
README

Material for MkDocs

A powerful documentation framework on top of MkDocs

Build Downloads Python Package Index Docker Pulls

Write your documentation in Markdown and create a professional static site for your Open Source or commercial project in minutes – searchable, customizable, more than 60 languages, for all devices.

Check out the demo – squidfunk.github.io/mkdocs-material.

 

Silver sponsors

 

Bronze sponsors

 

Everything you would expect

It's just Markdown

Focus on the content of your documentation and create a professional static site in minutes. No need to know HTML, CSS or JavaScript – let Material for MkDocs do the heavy lifting for you.

Works on all devices

Serve your documentation with confidence – Material for MkDocs automatically adapts to perfectly fit the available screen estate, no matter the type or size of the viewing device. Desktop. Tablet. Mobile. All great.

Made to measure

Make it yours – change the colors, fonts, language, icons, logo, and more with a few lines of configuration. Material for MkDocs can be easily extended and provides many options to alter appearance and behavior.

Fast and lightweight

Don't let your users wait – get incredible value with a small footprint by using one of the fastest themes available with excellent performance, yielding optimal search engine rankings and happy users that return.

Maintain ownership

Own your documentation's complete sources and outputs, guaranteeing both integrity and security – no need to entrust the backbone of your product knowledge to third-party platforms. Retain full control.

Open Source

You're in good company – choose a mature and actively maintained solution built with state-of-the-art Open Source technologies, trusted by more than 50,000 individuals and organizations. Licensed under MIT.

Quick start

Material for MkDocs can be installed with pip:

pip install mkdocs-material

Add the following lines to mkdocs.yml:

theme:
  name: material

For detailed installation instructions, configuration options, and a demo, visit squidfunk.github.io/mkdocs-material

Trusted by ...

... industry leaders

ArXiv, Atlassian, AWS, Bloomberg, CERN, Datadog, Google, Harvard, Hewlett Packard, HSBC, ING, Intel, JetBrains, LinkedIn, Microsoft, Mozilla, Netflix, OpenAI, Red Hat, Roboflow, Salesforce, SIEMENS, Slack, Square, Uber, [Zalando](https://opensource.zalando.com/skipper/

Extension points exported contracts — how you extend this code

Options (Interface)
* Options
src/templates/assets/javascripts/browser/request/index.ts
WatchOptions (Interface)
* Watch options
src/overrides/assets/javascripts/components/iconsearch/result/index.ts
Index (Interface)
* Index - expose inverted index
typings/lunr/index.d.ts
FormData (Interface)
(no doc)
typings/dom/index.d.ts
WatchOptions (Interface)
* Watch options
src/templates/assets/javascripts/browser/viewport/at/index.ts
MountOptions (Interface)
* Mount options
src/overrides/assets/javascripts/components/iconsearch/result/index.ts
Builder (Interface)
* Improve typings of query builder
typings/lunr/index.d.ts
MountOptions (Interface)
* Mount options
src/templates/assets/javascripts/components/progress/index.ts

Core symbols most depended-on inside this repo

add
called by 99
material/plugins/tags/structure/listing/__init__.py
replace
called by 96
material/plugins/search/plugin.py
keys
called by 86
typings/dom/index.d.ts
get
called by 65
src/plugins/tags/structure/mapping/manager/__init__.py
get
called by 64
material/plugins/tags/structure/mapping/manager/__init__.py
filter
called by 57
material/templates/assets/javascripts/lunr/wordcut.js
cb
called by 46
material/templates/assets/javascripts/lunr/wordcut.js
getElements
called by 41
src/templates/assets/javascripts/browser/element/_/index.ts

Shape

Function 1,286
Method 588
Class 169
Interface 118
Enum 4

Languages

TypeScript58%
Python42%

Modules by API surface

material/templates/assets/javascripts/bundle.79ae519e.min.js347 symbols
material/overrides/assets/javascripts/custom.f46acd93.min.js173 symbols
material/templates/assets/javascripts/lunr/wordcut.js139 symbols
src/plugins/blog/plugin.py55 symbols
material/templates/assets/javascripts/lunr/min/lunr.tr.min.js55 symbols
material/plugins/blog/plugin.py55 symbols
material/templates/assets/javascripts/workers/search.2c215733.min.js33 symbols
src/plugins/social/plugin.py32 symbols
material/plugins/social/plugin.py32 symbols
src/plugins/search/plugin.py31 symbols
material/plugins/search/plugin.py31 symbols
src/overrides/hooks/shortcodes.py27 symbols

Dependencies from manifests, versioned

@fortawesome/fontawesome-free7.1.0 · 1×
@mdi/svg7.4.47 · 1×
@primer/octicons19.21.1 · 1×
@stylistic/eslint-plugin-ts3.1.0 · 1×
@stylistic/stylelint-config3.0.1 · 1×
@stylistic/stylelint-plugin4.0.0 · 1×
@types/css-modules1.0.5 · 1×
@types/escape-html1.0.4 · 1×
@types/fuzzaldrin-plus0.6.5 · 1×
@types/html-minifier-terser7.0.2 · 1×
@types/lunr2.3.7 · 1×
@types/node25.0.3 · 1×

For agents

$ claude mcp add mkdocs-material \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact