# ProperDocs

Static site generator for project documentation, written in Markdown and configured with a YAML file, forked from MkDocs.


Source: https://findsoftware.frbit.cloud/properdocs/
Last reviewed: 2026-10-23
Updated: 2026-10-25
Listed since: 2026-10-23

## Record

### Links

- home: https://properdocs.org/
- repository: https://github.com/ProperDocs/properdocs
- docs: https://properdocs.org/user-guide/installation/
- plugins: https://github.com/ProperDocs/catalog
- discord: https://discord.gg/CwYAgEPHZd

### Identity

- status: active
- maintainer: ProperDocs Team
- maintainerType: community
- parent: unknown
- firstRelease: 2026
- hqCountry: unknown

### Kind

- category: ssg
- hosting: static
- language: python
- runtime: python
- runtimeMin: python 3.9
- basedOn: unknown

### Content

- contentStore: unknown
- databases: unknown
- adminUi: unknown
- headlessApi: unknown
- templating: unknown
- i18n: unknown

### Rendering and deploy

- runsAs: static
- renderingModes: static
- installMethod: pip

### License

- licenseModel: open-source
- license: BSD-2-Clause

### Releases

- currentMajor: 1
- latestReleaseDate: 2026-03-20

### Adoption

- githubStargazers: 302
- packagistDownloads: not applicable
- npmWeeklyDownloads: not applicable
- contributors: 231
- pluginCount: unknown
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: 1636169
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: unknown
- dependentPackages: unknown

### Sources

- urls: https://properdocs.org/ (read 2026-10-23)
- urls: https://api.github.com/repos/ProperDocs/properdocs (read 2026-10-23)
- urls: https://properdocs.org/ (read 2026-10-23)
- maintainer: https://properdocs.org/ (read 2026-10-23)
- language: https://api.github.com/repos/ProperDocs/properdocs (read 2026-10-23)
- category: https://properdocs.org/ (read 2026-10-23)
- runtime: https://properdocs.org/user-guide/installation/ (read 2026-10-23)
- runtimeMin: https://pypi.org/pypi/properdocs/json (read 2026-10-23)
- installMethod: https://properdocs.org/user-guide/installation/ (read 2026-10-23)
- renderingModes: https://properdocs.org/ (read 2026-10-23)
- runsAs: https://properdocs.org/user-guide/deploying-your-docs/ (read 2026-10-23)
- license: https://github.com/ProperDocs/properdocs/blob/master/README.md (read 2026-10-23)
- licenseModel: https://github.com/ProperDocs/properdocs/blob/master/README.md (read 2026-10-23)
- urls: https://github.com/ProperDocs/properdocs/blob/master/README.md (read 2026-10-23)
- firstRelease: https://api.github.com/repos/ProperDocs/properdocs/releases (read 2026-10-23)
- currentMajor: https://api.github.com/repos/ProperDocs/properdocs/releases (read 2026-10-23)
- latestReleaseDate: https://api.github.com/repos/ProperDocs/properdocs/releases (read 2026-10-23)
- githubStargazers: https://api.github.com/repos/ProperDocs/properdocs (read 2026-10-23)
- contributors: https://api.github.com/repos/ProperDocs/properdocs/contributors (read 2026-10-23)
- ecosystemsMonthlyDownloads: https://packages.ecosyste.ms/api/v1/registries/pypi.org/packages/properdocs (read 2026-10-25)

## Notes

ProperDocs is a static site generator for project documentation. Pages are written in Markdown, and a single `properdocs.yml` file sets the documentation structure, the theme and the plugin settings. The `properdocs build` command writes static HTML to a site folder, and any host that serves static files can serve it.

ProperDocs is a fork of MkDocs. It installs with pip, and the ProperDocs Team maintains it. Plugins and themes are listed in a catalog on GitHub.

The [deployment guide](https://properdocs.org/user-guide/deploying-your-docs/) covers GitHub Pages, Read the Docs and other static hosts.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0