properdocs
Project documentation with Markdown.
Decision gist · record as of 2026-08-14
Yes. ProperDocs is actively maintained, production-stable, has low install friction, carries no known vulnerabilities, and uses a permissive license. It is well-suited for developers building project documentation from Markdown. Install it if you need a straightforward static documentation generator; verify the plugin ecosystem and programmatic API match your workflow before committing to it for large projects.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.9 or later; the exact API for programmatic use should be verified against the package documentation.
- Low install friction with a pure-Python wheel and 13 runtime dependencies that are all standard tooling libraries.
- Active maintenance with a recent commit on 2026-07-19 and production-stable status.
License · maintenance · safety
BSD-2-Clause (permissive) — BSD-2-Clause is a permissive license that allows commercial and private use with minimal restrictions, requiring only license and copyright notice preservation.
last release 2026-03-20 (147 days) · last repo commit 2026-07-19 · 279 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 2,258,774 downloads/mo, #3,183 on PyPI
Alternatives
Verify before relying
pip install properdocs
Create a docs/ folder with Markdown files and a mkdocs.yml config, then:
from properdocs import build
build('docs')- Exact programmatic API surface and whether it's intended for CLI-only use or library integration
- Performance characteristics and scalability limits for large documentation projects
- Availability and maturity of third-party themes and plugins in the stated catalog
What it is and what it does
ProperDocs is a static documentation site generator built for developers who want to write project docs in Markdown and publish them as static HTML. It reads Markdown source files and a YAML configuration file, then generates a complete static website ready to deploy anywhere. The tool is designed around simplicity: one config file, standard Markdown input, and extensibility through themes and plugins rather than complex configuration.
The package depends on common Python tooling libraries—Markdown rendering, YAML parsing, file watching, and CLI handling—to provide a straightforward workflow. It targets the documentation use case specifically, with features like theme support and plugin architecture to customize output without forking the core tool.
Use it for
- Build and maintain project documentation for open-source or internal software projects using only Markdown and YAML.
- Generate static HTML documentation sites that can be hosted on GitHub Pages, S3, or any static file server.
- Create branded documentation by applying third-party themes or writing custom themes without modifying core code.
- Set up automated documentation builds triggered by changes to Markdown source files using the file-watching capability.
- Extend documentation generation with custom Markdown extensions or plugins to handle project-specific markup needs.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
ProperDocs is actively maintained, production-stable, has low install friction, carries no known vulnerabilities, and uses a permissive license. It is well-suited for developers building project documentation from Markdown. Install it if you need a straightforward static documentation generator; verify the plugin ecosystem and programmatic API match your workflow before committing to it for large projects.
Install
properdocs on PyPI
Before you install
Low install friction with a pure-Python wheel and 13 runtime dependencies that are all standard tooling libraries. Active maintenance with a recent commit on 2026-07-19 and production-stable status.
Requires Python 3.9 or later; the exact API for programmatic use should be verified against the package documentation.
License in practice
BSD-2-Clause is a permissive license that allows commercial and private use with minimal restrictions, requiring only license and copyright notice preservation.
Quickstart
pip install properdocs
Create a docs/ folder with Markdown files and a mkdocs.yml config, then:
from properdocs import build
build('docs')Verify before relying
- Exact programmatic API surface and whether it's intended for CLI-only use or library integration
- Performance characteristics and scalability limits for large documentation projects
- Availability and maturity of third-party themes and plugins in the stated catalog
Package facts
| License | BSD-2-Clause permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 13 packagesclickcoloramaghp-importimportlib-metadatajinja2markdownmarkupsafepackagingpathspecplatformdirspyyaml-env-tagpyyamlwatchdog |
| Maintenance | Actively maintained 147 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 2,258,774 / month, #3,183 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: ConsoleEnvironment :: Web EnvironmentIntended Audience :: DevelopersLicense :: OSI Approved :: BSD LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Programming Language :: Python :: 3.9Topic :: DocumentationTopic :: Text ProcessingTyping :: Typed |
Evidence: properdocs-1.6.7-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 › “markdown to static html documentation”
- properdocsProperDocs is a static site generator that converts Markdown…
- mkdocsMkDocs generates static HTML documentation sites from Markdown source…
- zensicalZensical is a static site generator that converts Markdown…
Give your agent the search over MCP, or paste the wish link into any chat.
More Text Processing packages
A drop-in replacement for Python's standard `re` module that adds advanced regex features like nested sets, fuzzy matching, lookaround in conditionals, and full Unicode case-folding while maintaining backward compatibility.
pyparsing provides a library for building text parsers directly in Python code using composable grammar classes, handling quoted strings, whitespace variation, and embedded comments without regex or lex/yacc.
Install it if you need to parse text or define grammars programmatically.
fonttools manipulates font files in multiple formats (TrueType, OpenType, AFM, Type 1, Mac-specific) and includes TTX, a tool to convert fonts to and from XML text format.
Install it if you need to read, write, or manipulate fonts programmatically or via the TTX command-line tool.
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
RapidFuzz provides fast fuzzy string matching using Levenshtein Distance and related metrics, implemented mostly in C++ with Python bindings for rapid similarity scoring and approximate string matching.
Install it if you need fuzzy string matching; it's a solid replacement for FuzzyWuzzy with better licensing and performance.
tinycss2 parses CSS strings into token and block objects, and generates CSS strings from those objects, following the CSS Syntax Level 3 specification without enforcing specific properties or values.
Install it if your project requires CSS tokenization or syntax manipulation.
See also mkdocs · mkdocs-same-dir · mkdocstrings · mkdocs-material · pelican · mkdocs-techdocs-core · mkdocs-gen-files · mkdocs-include-markdown-plugin · mkdocs-jupyter · mkdocs-macros-plugin