macOS
Homebrewverified · 100%
brew install mkdocslocal Homebrew formula metadata
brew
Install mkdocs with Homebrew, apk, chocolatey, apt, dnf, Nix, pacman
Project documentation with Markdown. Version 1.6.1 via Homebrew; verified 2026-07-13. Also installable with debian: sudo apt install mkdocs.
install
Additional install commands
Linux
Alpine Linux apkverified · 92%
sudo apk add mkdocsAlpine Linux edge package indexes · mkdocs · source: dl-cdn.alpinelinux.org
Debian aptverified · 92%
sudo apt install mkdocsDebian stable package indexes · mkdocs · source: deb.debian.org
Fedora dnfverified · 92%
sudo dnf install mkdocsFedora Rawhide package metadata · mkdocs · source: dl.fedoraproject.org
Nixverified · 92%
nix profile install nixpkgs#mkdocsnixpkgs package indexes · mkdocs · source: raw.githubusercontent.com
Arch Linux pacmanverified · 92%
sudo pacman -S mkdocsArch Linux sync databases · mkdocs · source: geo.mirror.pkgbuild.com
Windows
Chocolateyverified · 92%
choco install mkdocsChocolatey community package catalog · mkdocs · source: community.chocolatey.org
overview
Package summary
Project documentation with Markdown
Project links
Commands and aliases
- mkdocs
history
Project history and usage
MkDocs is a Python static site generator for project documentation. Its documentation credits Tom Christie in the 2014 copyright line and the MkDocs team as maintainers, while the public GitHub repository was created in January 2014. The project established a simple convention that became its niche: documentation lives as Markdown files, site settings live in a single mkdocs.yml file, and the mkdocs command builds a static HTML site or runs a local auto-reloading preview server.
Project history
The tool grew around a small core with extension points rather than a large documentation platform. Its own README and site emphasize themes, plugins, and Python Markdown extensions; built-in and third-party themes handle presentation, plugins add indexing or generated content, and the output can be hosted anywhere static files are served. Release notes show the 1.0 release in 2018 and continued 1.x maintenance through 1.6.1 in 2024, including changes around local preview, drafts, translations, and strict-mode behavior.
How it is used
MkDocs sits in package managers as the base documentation generator. It is packaged widely across Linux distributions, Homebrew, Chocolatey, and Nix, and Homebrew records a conflict with mkdocs-material because both packages install a mkdocs binary. GitHub metadata shows broad adoption for the repository, with tens of thousands of stars and many dependent projects, which fits its role as the common base beneath themes such as Material for MkDocs.
Sources
security posture
No protected-tool coverage found yet
No matching local secret-handling manifest was found for mkdocs. Nucleus package metadata is still published here so future coverage has a stable package URL.
Install behavior
- No Homebrew post-install hook is recorded in formula metadata.
- Homebrew bottle metadata is available for 6 platform targets.
- Installs with 2 runtime dependencies.
Recommended review
Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.
local files
Configuration and credential file locations
These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.
Configuration files
Config paths the tool may read or write during local use.
- Unix
mkdocs.yml
executables
Installed executables
| Command | Kind | Exposure | Note |
|---|---|---|---|
mkdocs | cli | global executable |
freshness
Version and freshness
These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.
page generated2026-07-25
manager version1.6.1
manager updated2026-07-13
local dataok
upstreamnot checked
latest detectednot detected
- infoRelease/tag comparison is only available for GitHub repositories.https://www.mkdocs.org/none confidence
install metadata
Package metadata
| Package key | brew:mkdocs |
|---|---|
| Version | 1.6.1 |
| Package manager | Homebrew |
| Package manager page | https://formulae.brew.sh/formula/mkdocs |
| Homepage | https://www.mkdocs.org/ |
| Repository | https://github.com/mkdocs/mkdocs |
| Upstream docs | https://www.mkdocs.org/ |
| License | BSD-2-Clause |
| Source archive | https://files.pythonhosted.org/packages/bc/c6/bbd4f061bd16b378247f12953ffcb04786a618ce5e904b8c5a01a0309061/mkdocs-1.6.1.tar.gz |
| Last updated | 2026-07-13T11:00:34Z |
| Pulse | updated |
| Dependencies | libyaml, python@3.14 |
| Bottle | available (on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux) |
| Homebrew post-install | not defined |
| Service | none declared |
registry facts
Source database details
| Source Database | Homebrew formula API |
|---|---|
| Tap | homebrew/core |
| Full Name | mkdocs |
| Version Scheme | 0 |
| Revision | 3 |
| Conflicts With |
|
| Bottle Stable Root URL | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
source database matches
Other package-manager records
Matches are pulled from external package-manager indexes and kept separate from local Automic Vault package links.
Debian apt95%
mkdocs 1.6.1+dfsg1-2
Static site generator geared towards building project documentation
https://github.com/mkdocs/mkdocs
sudo apt install mkdocs- Section: python
- Architecture: all
- Source Package: python-mkdocs
- 22 dependencies
- 1 provides
- 3 optional deps
- normalized package name match
- Matched by: Mkdocs
Nix95%
mkdocs
nix profile install nixpkgs#mkdocs- normalized package name match
- Matched by: Mkdocs
Ubuntu apt95%
mkdocs 1.5.3+dfsg-1
Static site generator geared towards building project documentation
sudo apt install mkdocs- Section: universe/text
- Architecture: all
- Source Package: python-mkdocs
- 25 dependencies
- 1 provides
- 3 optional deps
- normalized package name match
- Matched by: Mkdocs
apk95%
mkdocs 1.6.1-r1
Project documentation with Markdown
sudo apk add mkdocs- License: BSD-2-Clause
- Architecture: x86_64
- Source Package: mkdocs
- 1 dependencies
- 1 provides
- normalized package name match
- Matched by: Mkdocs
apk95%
mkdocs-pyc 1.6.1-r1
Precompiled Python bytecode for mkdocs
sudo apk add mkdocs-pyc- License: BSD-2-Clause
- Architecture: x86_64
- Source Package: mkdocs
- 1 dependencies
- normalized package name match
- Matched by: Mkdocs
dnf95%
mkdocs 1.6.1-10.fc45
Python tool to create HTML documentation from markdown sources
sudo dnf install mkdocs- License: BSD-2-Clause AND OFL-1.1-RFN AND Apache-2.0 AND OFL-1.1 AND MIT AND (MIT OR GPL-2.0-only) AND MPL-1.1
- Category: Unspecified
- Architecture: noarch
- Source Package: mkdocs
- 6 dependencies
- 4 provides
- normalized package name match
- Matched by: Mkdocs
pacman95%
mkdocs 1.6.1-3
Project documentation with Markdown
sudo pacman -S mkdocs- License: BSD-2-Clause
- Architecture: any
- 16 dependencies
- 1 optional deps
- normalized package name match
- Matched by: Mkdocs
Chocolatey95%
mkdocs
choco install mkdocs- normalized package name match
- Matched by: Mkdocs
source trail
Generated from repository data
This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.
Combined YAML source
View the package source record on GitHub.
Used sources
- Nucleus package database
- av.db category and tag curation
- cross-ecosystem install command graph
- curated configuration and credential file locations
- curated package history
- external package-manager database matches
- package relationship graph
- package version freshness
- package-page enrichment