Heads-up
For a small handful of stable screenshots, /static is simpler. swiftimg is best when docs include many user-supplied screenshots or product UI that changes often.
Step by step
1. Upload from the CLI
Use `@swiftimg/cli` so screenshot uploads from CI or a shell are one command.
Shell swiftimg upload screenshot.png --title "Settings panel"2. Reference from MDX
Standard Markdown image syntax works in any .mdx file.
docs/intro.mdx 3. Use a custom MDX component for figure / caption (optional)
Wrap the URL in a `<Figure>` component for captioned screenshots.
Docusaurus — FAQ
Does Docusaurus's image plugin still apply?
It processes /static images. swiftimg URLs are remote and bypass that pipeline; swiftimg's global cache handles caching instead.
Will image links survive a Docusaurus version upgrade?
Yes — they're absolute URLs, decoupled from the docs site's routing.
Can I use swiftimg in API reference auto-generated pages?
Yes — any MDX, including auto-generated API references, accepts external image URLs.
See also
Image hosting for GitHub README
Upload screenshots, diagrams, and GIFs and embed them in a GitHub README with a Markdown snippet. No account needed; the direct URL is permanent and globally cached.
Image hosting for Stack Overflow
Upload screenshots and diagrams to swiftimg and paste a Markdown image link into a Stack Overflow question or answer. Permanent URLs, no account required.
Image hosting for Obsidian
Host attachments on swiftimg and embed them in Obsidian notes with a Markdown image link. Keeps the vault small, makes the notes portable, and works across devices.
swiftimg vs GitHub user-attachments
An open alternative to GitHub user-attachments — works for unauthenticated viewers and outside issues.
Hosting for Docusaurus works on the free plan — see swiftimg pricing and plan limits for what each tier includes, or read the image hosting API documentation to upload from your own code instead of the browser.
Ready to host your Docusaurus images?
Start free, then unlock the full API, transforms, signed URLs, and a custom domain on the Developer plan.