Hostable Publishing
Export your documentation as a hostable static site with server-side rendered HTML, sitemap.xml, robots.txt, and llms.txt. Deploy to any static web host including Netlify, Vercel, Cloudflare Pages, or your own infrastructure.
Hostable publishing generates a production-ready static site with server-side rendered (SSR) HTML for every page. Unlike local publishing (which uses hash-based routing for file:// access), hostable publishing produces clean URL paths, SEO metadata, and pre-rendered HTML that any static web host can serve.
What Hostable Publishing Generates
Hostable publishing produces additional files compared to local publishing:
| Output | Description |
|---|---|
| SSR HTML pages | Pre-rendered HTML for every page, schema, endpoint, and API definition. Each gets its own index.html for clean URLs. |
| sitemap.xml | XML sitemap listing all published URLs for search engine discovery |
| robots.txt | Search engine crawling directives (configurable in site settings) |
| llms.txt | Large language model discovery information (configurable in site settings) |
| SEO metadata | Open Graph tags, Twitter Card tags, JSON-LD structured data, and canonical URLs in every page |
| Separate viewer bundle | JavaScript extracted into a separate file for progressive enhancement |
Publishing to a Hostable Folder
Hostable vs Local Publishing
| Feature | Local | Hostable |
|---|---|---|
| URL routing | Hash-based (#/path) | Path-based (/pages/path) |
| SSR HTML | No | Yes, one index.html per page |
| sitemap.xml | No | Yes |
| robots.txt | No | Yes |
| llms.txt | No | Yes |
| SEO metadata | No | Open Graph, Twitter Card, JSON-LD |
| Resource paths | Relative (./data/) | Absolute (/data/) |
| File system viewing | Yes (file:// protocol) | No, requires a web server |
| Progressive enhancement | No | Yes, SSR HTML loads before JavaScript |
Output Directory Structure
output-folder/
index.html # Main entry point
sitemap.xml # SEO sitemap
robots.txt # Crawler directives
llms.txt # LLM discovery info
assets/ # JavaScript, CSS, fonts
viewer-bundle.js # Extracted viewer bundle
data/ # Content data files
pages.js
schemas.js
rest-endpoints.js
rest-api-info.js
graphql-operations.js
graphql-api-info.js
diagrams.js
graph-diagrams.js
graph-links.js
adrs.js
tree.js
settings.js
search.js
home-graph-links.js
intent-graph.js
pages/ # SSR HTML for pages
articles/
my-article/
index.html
rest-endpoints/ # SSR HTML for endpoints
schemas/ # SSR HTML for schemas
graphql-operations/ # SSR HTML for GraphQL
rest-api-info/ # SSR HTML for API docs
graphql-api-info/ # SSR HTML for GraphQL docs
images/ # Images from contentSSR and Progressive Enhancement
Each SSR HTML file contains the full page content as static HTML. When a visitor loads the page, they see the content immediately without waiting for JavaScript. The viewer bundle then loads and enhances the page with interactive features such as search, navigation, theme switching, and diagram interactivity.
SEO Metadata
Every SSR HTML page includes:
| Metadata | Content |
|---|---|
| Title tag | Page title and site name |
| Meta description | Page summary |
| Canonical URL | Full URL based on site URL setting |
| Open Graph tags | og:title, og:description, og:type, og:url |
| Twitter Card tags | twitter:card, twitter:title, twitter:description |
| JSON-LD | Structured data (Article, WebPage, or TechArticle) |
Hosting Options
The generated site can be deployed to any static hosting service:
URL Rewriting
Because hostable sites use path-based routing (/pages/my-article), the web server needs to route requests for unknown paths to index.html. Most static hosts handle this automatically. For self-hosted servers, configure a fallback rule.