Skip to content

Material for MkDocs

Material for MkDocs sets a generator tag naming mkdocs-material (or zensical), which alone is enough for a high-confidence match. Without it, [data-md-component], [data-md-color-scheme], or the .md-content class match on structure, and a generic mkdocs generator adds weak support. Plain MkDocs and its ReadTheDocs theme are detected separately as mkdocs and mkdocs-rtd; see the overview.

Content selector: article.md-content__inner, .md-content article, .md-content.

$ doc-scraper add -config config.yaml -dry-run https://squidfunk.github.io/mkdocs-material/getting-started/
Probing https://squidfunk.github.io/mkdocs-material/getting-started/ ...
Detected: mkdocs-material (mkdocs-1.6.1, mkdocs-material-9.7.0+insiders-4.53.18) via generator, confidence high
Corpus: ~108 pages (sitemap)
Drafted entry:
squidfunk_docs:
start_urls:
- https://squidfunk.github.io/mkdocs-material/getting-started/
allowed_domain: squidfunk.github.io
allowed_path_prefix: /mkdocs-material/
content_selector: article.md-content__inner, .md-content article, .md-content
max_depth: 6
# content_selector: mkdocs-material detected via generator (high confidence), validated on the fetched page
# allowed_path_prefix: /mkdocs-material/ covers 108 of 108 sitemap URLs
# max_depth: 6 from sitemap path depth under the prefix
Preview of the fetched page:
6349 chars of markdown, 52% of page text, code blocks 10/10, 5 headings
note: extracted content still contains nav/sidebar elements
...
Dry run: nothing written.

Output from doc-scraper 2.10.1 (built from main) against https://squidfunk.github.io/mkdocs-material/getting-started/, 2026-10-11. Exit code 2.

sites:
squidfunk_docs:
start_urls:
- https://squidfunk.github.io/mkdocs-material/getting-started/
allowed_domain: squidfunk.github.io
allowed_path_prefix: /mkdocs-material/
content_selector: article.md-content__inner, .md-content article, .md-content
max_depth: 6
Terminal window
doc-scraper crawl -site squidfunk_docs
  • The site key is derived from the host, so this one is squidfunk_docs. Pass -site mkdocs_material to choose your own.