mkdocs-simple-hooks
Define your own hooks for mkdocs, without having to create a new package.
Decision gist · record as of 2026-08-14
Yes, if you need simple, project-scoped hooks for MkDocs and are comfortable with dormant maintenance. The package is lightweight, has no known vulnerabilities, and solves a real friction point—avoiding a full plugin package for small customizations. Verify compatibility with your MkDocs version before adopting.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Low install friction with a single runtime dependency on mkdocs.
- Maintenance is dormant—last release was in January 2022, though the repository remains unarchived.
License · maintenance · safety
MIT (permissive) — MIT license is permissive; you can use, modify, and distribute this package freely with minimal restrictions.
last release 2022-01-07 (1680 days) · last repo commit 2023-11-14 · 68 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 236,486 downloads/mo, #8,982 on PyPI
Alternatives
Verify before relying
pip install mkdocs-simple-hooks
# In mkdocs.yml:
plugins:
- mkdocs-simple-hooks:
hooks:
on_pre_build: "docs.hooks:my_function"
# In docs/hooks.py:
def my_function(*args, **kwargs):
pass- Whether the package works with MkDocs versions released after the last release date of 2022-01-07
- Current compatibility with Python 3.10 given the dormant maintenance status
What it is and what it does
mkdocs-simple-hooks is a MkDocs plugin that allows you to register custom hook functions without the overhead of creating and maintaining a separate plugin package. You define Python functions in your project (typically in a `docs/hooks.py` file) and register them in `mkdocs.yml` to run at specific build lifecycle events—such as `on_pre_build` or `on_post_build`—using a simple module-path syntax.
The plugin acts as a bridge between your MkDocs configuration and arbitrary Python code, letting you automate tasks like copying files, modifying content, or triggering external processes as part of your documentation build. It's designed for lightweight, project-specific customizations that don't warrant a full plugin package.
Use it for
- Copy or generate files before the documentation build (e.g., README to index.md)
- Run custom preprocessing or validation logic on your docs during the build
- Trigger external tools or scripts at specific points in the MkDocs lifecycle
- Conditionally enable or disable build steps using environment variables
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you need simple, project-scoped hooks for MkDocs and are comfortable with dormant maintenance.
The package is lightweight, has no known vulnerabilities, and solves a real friction point—avoiding a full plugin package for small customizations. Verify compatibility with your MkDocs version before adopting.
Install
mkdocs-simple-hooks on PyPI
Before you install
Low install friction with a single runtime dependency on mkdocs. Maintenance is dormant—last release was in January 2022, though the repository remains unarchived.
License in practice
MIT license is permissive; you can use, modify, and distribute this package freely with minimal restrictions.
Quickstart
pip install mkdocs-simple-hooks
# In mkdocs.yml:
plugins:
- mkdocs-simple-hooks:
hooks:
on_pre_build: "docs.hooks:my_function"
# In docs/hooks.py:
def my_function(*args, **kwargs):
passVerify before relying
- Whether the package works with MkDocs versions released after the last release date of 2022-01-07
- Current compatibility with Python 3.10 given the dormant maintenance status
Package facts
| License | MIT permissive |
| Python support | Not specified |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagemkdocs |
| Maintenance | Dormant 1,680 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 236,486 / month, #8,982 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Intended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseOperating System :: OS IndependentProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.6Programming Language :: Python :: 3.7Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9Topic :: Documentation |
Evidence: mkdocs_simple_hooks-0.1.5-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “mkdocs custom hooks”
- mkdocs-simple-hooksA MkDocs plugin that lets you define custom hooks directly in your…
- mkdocs-drawioA MkDocs plugin that embeds interactive Drawio diagrams directly into…
- mdformat-mkdocsAn mdformat plugin that formats Markdown for MkDocs projects,…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also mkdocs-awesome-pages-plugin · mkdocs-monorepo-plugin · mkdocs-link-marker · mkdocs-get-deps · mkdocs-macros-plugin · mkdocs-include-markdown-plugin · mkdocs-multirepo-plugin · mkdocs-meta-manager · mkdocs-exclude · jinjanator-plugins