Embed Reference Pages Anywhere
Add AutomaDocs reference pages directly to your website, developer portal, or internal tools. One snippet, always in sync.
<iframe
src="https://automadocs.com/embed/{username}/{repo}"
width="100%"
height="600"
frameborder="0"
title="Reference Pages"
></iframe>Everything Built In
Responsive Design
Adapts to any container size, works on desktops, tablets, and mobile. No extra CSS needed.
Dark / Light Mode
Automatically matches your site's theme or set it explicitly with a parameter.
Search Included
Full-text and source-grounded search built in. Users find answers without leaving your site.
Auto-Updates
Push to GitHub and embedded pages update automatically. Zero manual maintenance.
Where Teams Embed Docs
Your reference content lives where your users already are.
Developer Portals
Embed API references directly in your developer portal alongside auth, SDKs, and changelogs.
Internal Wikis
Add living code references to Notion, Confluence, or your company wiki. Always up to date.
Customer-Facing Docs
Ship reference pages alongside your product. Customers see content in your UI, not on a separate site.
Marketing Sites
Show your reference content directly on marketing pages so developers can evaluate your product faster.
Embed Performance and Security Notes
For production portals, reserve a fixed container height, lazy-load below-the-fold embeds, and include a clear title attribute for accessibility. This avoids layout shift and keeps navigation predictable for keyboard users.
Recommended Setup
Start with one embedded docs area per page and include direct links to full documentation routes for advanced reading and search-heavy sessions.
Governance
Treat embed configuration as part of release review. Confirm source repository, access scope, and update cadence whenever product surfaces change.