fastapi-docs
A markdown documentation renderer for FastAPI applications.
Features
- 📁 Directory-based navigation from your markdown file structure
- 🔍 Full-text search across all documents
- 🎨 Syntax highlighting for Python, JavaScript, bash, C#, HTML
- 🌙 Automatic dark mode based on system preference
- 📱 Responsive design for mobile and desktop
- ⚡ Hot-reload during development
- 📑 Table of contents for each page
- 🔗 Previous/next navigation
Installation
pip install -e .
Quick Start
from fastapi import FastAPI
from fastapi_docs import create_docs_router, DocsConfig
app = FastAPI()
# Simple usage
app.include_router(create_docs_router("./userdocs"), prefix="/userdocs")
# Or with configuration
config = DocsConfig(
docs_dir="./userdocs",
title="My API Docs",
auto_refresh=True,
)
app.include_router(create_docs_router(config), prefix="/userdocs")
Markdown Frontmatter
Each markdown file can include YAML frontmatter:
---
title: Getting Started
order: 1
description: Learn how to get started
tags:
- quickstart
hidden: false
---
# Getting Started
Your content here...
Running the Example
pip install -e ".[dev]"
uvicorn example_app:app --reload
Then visit http://localhost:8000/userdocs
License
MIT
Metadata
Release files for fastapi-docs 0.1.6
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 | Actions |
|---|---|---|---|---|
| fastapi_docs-0.1.6.tar.gz | 1.4 MB | Without provenance | Details for fastapi_docs-0.1.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fastapi_docs-0.1.6-py3-none-any.whl | Python 3 | none | any | Details for fastapi_docs-0.1.6-py3-none-any.whl |
Total release size: 1.4 MB
Release files / fastapi_docs-0.1.6.tar.gz
| Download URL | fastapi_docs-0.1.6.tar.gz |
|---|---|
| Size | 1.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
438097a1ee7f607001d30c55f0859f0ae6c4f6b551034b3f43427d307757e867
|
|
BLAKE2b-256 checksum How to use checksums |
9572f22373218120f4dde9f88e44da3b6701412921fa7ba1b016cf3dbf37ac49
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.12
|
Release files / fastapi_docs-0.1.6-py3-none-any.whl
| Download URL | fastapi_docs-0.1.6-py3-none-any.whl |
|---|---|
| Size | 16.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d71d96cefa5eb12a23e7e5174663982730ac2e29dfd883744e43da5c1292a658
|
|
BLAKE2b-256 checksum How to use checksums |
ee9da1124ffd96aca814fb7da4a546d9a5612d29cfa596879ad65fb834a2f55a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.12
|
Security for fastapi-docs 0.1.6
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A 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.