Skip to content

README.md

Latest commit

 

History

History
47 lines (32 loc) · 3.04 KB

README.md

File metadata and controls

47 lines (32 loc) · 3.04 KB
Raw

docs.bunny.net

Welcome to the bunny.net docs repository. You'll find the source code for all product docs, API references, guides, and more.

Products

Product Description Docs Source
CDN Accelerate and protect your content globally docs.bunny.net/cdn /cdn
Stream Video streaming and delivery platform docs.bunny.net/stream /stream
Storage Global object storage docs.bunny.net/storage /storage
Optimizer Automatic image and web optimization docs.bunny.net/optimizer /optimizer
Magic Containers Deploy any app anywhere with Docker docs.bunny.net/magic-containers /magic-containers
Scripting Deploy serverless code at the edge docs.bunny.net/scripting /scripting
Database Serverless SQLite over HTTP docs.bunny.net/database /database
Shield Stay protected and online no matter what docs.bunny.net/shield /shield
DNS Ultra-fast scriptable DNS platform docs.bunny.net/dns /dns

Local Development

Install the Mintlify CLI:

npm i -g mintlify

Run the docs locally:

mintlify dev

Open http://localhost:3000.

OpenAPI Specs

API references are generated from OpenAPI specs in docs.json. Local specs (in /api-reference/) deploy automatically on merge. Remote specs (Stream, Shield, Magic Containers, Database) don't trigger deploys when they change.

To rebuild after a remote spec changes:

  1. API (recommended): POST https://api.mintlify.com/v1/project/update/{projectId} with auth header
  2. Manually: Trigger from the Mintlify dashboard
  3. Wait: It'll rebuild on the next PR merge

Contributing

See CONTRIBUTING.md.