# mkdocs/mkdocs

Project documentation with Markdown.

Repository: https://github.com/mkdocs/mkdocs
Canonical: https://ross.abutalabs.com/products/mkdocs
Homepage: https://www.mkdocs.org
Language: Python
License: BSD-2-Clause
License Family: permissive
Topics: mkdocs, documentation, static-site-generator, markdown, python
Last push: 2025-10-20T13:17:06+00:00

## Health v2 (maintenance only)
Score: 44/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 48, release rhythm 8, longevity 100
- inputs: {"age_days": 4617, "days_push": 317, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 22379, forks 2645 (observed 2026-08-28T04:11:32.569665+00:00)

## What it is
MkDocs is a fast, simple static site generator geared toward building project documentation from Markdown source files, configured with a single YAML file. It includes a live-reloading dev server, built-in and third-party themes, a plugin system, and one-command deployment to GitHub Pages.

## Use cases
- generate project documentation from markdown files
- build a static docs site with a yaml config
- preview documentation locally with live reload
- publish docs to github pages
- create a documentation site with themes and plugins
- convert markdown docs to static html

## When to choose
- you want to write docs in Markdown with minimal setup
- you need a static documentation site hostable anywhere
- you want live preview while writing docs
- you want an extensible docs tool with themes and plugins

## When to avoid
- you need dynamic, server-side functionality or user authentication
- you prefer docs-as-code tools with richer features like versioned docs out of the box (e.g. Sphinx)
- you need a general-purpose website builder rather than documentation

## Facets
- artifact type: cli-tool
- maturity: stable
- function: static-site-generator, documentation, cli, markdown, templating
- domain: documentation, web-development, developer-tools
- platform: python, cli, cross-platform
- tags: docs-site, yaml-config, dev-server, github-pages, themes, plugins, command-line

## Member repositories
- mkdocs/mkdocs (main) score 44

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:11:32.569665+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T16:57:20.717675+00:00, confidence not recorded.
  - readme: https://github.com/mkdocs/mkdocs (fetched 2026-08-28T04:11:32.569665+00:00, sha 745673d7a4e4)
  - homepage: https://www.mkdocs.org (fetched 2026-08-29T07:55:42.537187+00:00, sha 01224c7e60f8)
  - site_page: https://www.mkdocs.org/getting-started (fetched 2026-08-29T07:55:42.540409+00:00, sha e18c5be5d632)
  - site_page: https://www.mkdocs.org/user-guide/installation (fetched 2026-08-29T07:55:42.543396+00:00, sha 264168bcb690)
  - site_page: https://www.mkdocs.org/user-guide/writing-your-docs (fetched 2026-08-29T07:55:42.545875+00:00, sha db8ba3b47c91)
  - site_page: https://www.mkdocs.org/user-guide/deploying-your-docs (fetched 2026-08-29T07:55:42.548890+00:00, sha dfcdb2ac99b5)
  - site_page: https://www.mkdocs.org/about/release-notes (fetched 2026-08-29T07:55:42.551699+00:00, sha f25e7df081ea)
  - site_page: https://www.mkdocs.org/about/contributing (fetched 2026-08-29T07:55:42.557157+00:00, sha 006de663c325)
  - site_page: https://www.mkdocs.org/about/license (fetched 2026-08-29T07:55:42.559893+00:00, sha 1742eb5843c4)
  - site_page: https://www.mkdocs.org/user-guide/choosing-your-theme (fetched 2026-08-29T07:55:42.562092+00:00, sha 03ff210d9d5b)
- Data as of 2026-08-30T08:39:29.467469+00:00.