Fr-docs
Generate fast, fully featured, modern documentation pages from markdown for GitHub pages and static hosting.
Documentation
Overview
Fr-docs is a generic, configurable documentation builder for Python projects. It converts Markdown source files into a searchable, optimized static HTML site with zero-config setup.
Key Features
- Toggleable features: Disable any features in the config.
- Search: Search pages, headers, source code files, or symbols. Fuzzy matching included.
- Markdown features: Feature-complete markdown features, including:
- Code highlighting: Highlight code blocks with
fastpylight - Copy code blocks: Copy buttons on multiline code blocks, inline copy code blocks.
- Tables: Auto convert markdown tables
- Frontmatter metadata: Title and description as optional frontmatter.
- Hover previews: Hover a link to see the title and description, hover a code ref to see a code preview.
- Code references: Link to a source code files, lines, line ranges, or symbols. Automatically generates a clickable code ref.
- Custom tags: Highlight tags such as
[ext]automatically across the site.
- Code highlighting: Highlight code blocks with
- Auto versioned: Automatically switch to older documentation based on github tags.
(requires site/ to be commited into the repo) - Auto minification: Minifies HTML, CSS and JS and inlines Critical CSS.
- Same-origin fonts: Serve fonts from the same origin. Download once before build, serve forever.
- Page preloading: Preload page links for faster browsing.
- Configurable elements: Configure project name, icon, copyright, topbar links, etc.
Projects that use fr-docs
1 maintainer
Metadata
1 maintainer
Release files for fr-docs 5.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| fr_docs-5.1.0.tar.gz | 50.1 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fr_docs-5.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 104.8 kB
Release files / fr_docs-5.1.0.tar.gz
| Download URL | fr_docs-5.1.0.tar.gz |
|---|---|
| Size | 50.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cdcd09f9b25f957fd6e884c2427a0219df6170591692b9bc2f6b5b05eea69d5d
|
|
BLAKE2b-256 checksum How to use checksums |
f96b070a2373935381030d9e842b41d1260f8b415a488ae908a2df426568e53e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 23, 2026.
Transparency logRelease files / fr_docs-5.1.0-py3-none-any.whl
| Download URL | fr_docs-5.1.0-py3-none-any.whl |
|---|---|
| Size | 54.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
10c2dd103c3f9be7127640ab0da8d62d5c6e8faeb733d8c61c5b28e6449363ca
|
|
BLAKE2b-256 checksum How to use checksums |
7d0c977687fd833fba8d73db0ba9ecbbb1a5d9c05ddb8f2ec43f0dd11f3b57d9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 23, 2026.
Transparency logSecurity for fr-docs 5.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for fr_docs-5.1.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 23, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
