https://github.com/community-of-python/litestar-offline-docs

Offline API docs for Litestar
https://github.com/community-of-python/litestar-offline-docs

Last synced: 2 months ago
JSON representation

Offline API docs for Litestar

• Host: GitHub
• URL: https://github.com/community-of-python/litestar-offline-docs
• Owner: community-of-python
• Created: 2024-07-05T15:26:55.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-10-28T09:26:24.000Z (3 months ago)
• Last Synced: 2024-10-28T11:41:20.569Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 1.13 MB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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).