Metadata-Version: 2.1
Name: litestar-offline-docs
Version: 1.0.2
Summary: Offline API docs for Litestar
Author: community-of-python
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: litestar[standard] (>=2.9.1,<3.0.0)
Description-Content-Type: text/markdown

# litestar-offline-docs

This package enables "offline mode" for FastAPI (in other words lets you avoid loading assets from CDN).

# Installation

```sh
poetry add litestar-offline-docs
```

# Usage

Just construct static file handler and add it to Litestar application during initialization:

```python
import litestar

from litestar_offline_docs import generate_static_files_config

app = litestar.Litestar(
    static_files_config=[generate_static_files_config()],
    ...
)
```

That's it. Now, the assets for API docs are served locally, not from CDN.

See also: [fastapi-offline-docs](https://github.com/community-of-python/fastapi-offline-docs).

