Skip to content

Published site features

When you publish a web target, readers get a documentation site with the following features.

  • Sidebar — reflects the map hierarchy with expandable/collapsible sections. Active page is highlighted with the site's brand color. On screens below 1024px, the sidebar collapses into a hamburger menu with a dark overlay.

  • Breadcrumbs — show the reader's position within the hierarchy

  • Previous/next links — sequential navigation between pages at the bottom of each page

  • Homepage — landing page with site name, logo, search bar, and page cards

  • Version selector — if multiple versions of the same map are published, a dropdown in the header lets readers switch between versions. Selecting a version navigates to the same page in the other version's site.

  • Full-text search — press Cmd+K (Mac) or Ctrl+K (Windows/Linux) from any page to focus the search input. The keyboard hint adapts to the reader's platform.

  • Result previews — up to 8 results appear in a dropdown, matching against page titles and content. Click a result to navigate directly.

  • AI-powered search — readers can ask natural language questions via the Ask AI widget (Pro, Team, and Business plans). Powered by Gemini.

  • Search analytics — search queries are anonymously logged and appear in your search analytics dashboard.

Press Cmd+K (Mac) or Ctrl+K (Windows/Linux) from any page to instantly open the search dialog. This keyboard shortcut is shown in the search bar itself, so readers discover it naturally.

Per-page features

  • Table of contents — generated from H2 and H3 headings, displayed in a sticky right column on screens 1280px and wider. Scroll spy highlights the current section as the reader scrolls, updating the active heading indicator in real time.

  • "Was this helpful?" widget — thumbs up/down feedback at the bottom of each page. Results appear in your feedback dashboard.

  • Copy-to-clipboard buttons — every code block shows a copy button in the top-right corner on hover (always visible on touch devices). A checkmark confirms the copy for 2 seconds. Accessible via keyboard (Enter or Space).

  • Code group tabs — when a topic contains multiple consecutive code blocks in different languages, they display as a tabbed group. The reader's language preference is stored in the browser, so their selection persists across pages.

  • Try It API explorer — pages imported from an OpenAPI spec display interactive "Try it" panels below each endpoint heading. The panel includes URL input, path and query parameter fields, authorization header input, request body editor, and a response display area. Requests are proxied to avoid CORS issues. HTTP method badges are color-coded: green for GET, blue for POST, orange for PUT, purple for PATCH, red for DELETE.

Feature availability by plan

Feature

Free

Pro

Team

Business

Sidebar navigation

Yes

Yes

Yes

Yes

Full-text search

Yes

Yes

Yes

Yes

Dark mode

Yes

Yes

Yes

Yes

Feedback widget

Yes

Yes

Yes

Yes

Code copy buttons

Yes

Yes

Yes

Yes

Version selector

Yes

Yes

Yes

Yes

AI-powered search

No

Yes

Yes

Yes

Embed widget

No

Yes

Yes

Yes

Try It API explorer

No

Yes

Yes

Yes

Custom CSS

No

No

Yes

Yes

Search analytics

No

Yes

Yes

Yes

Display

  • Dark mode — toggle in the site header (moon/sun icon). The reader's preference is stored in the browser and applied on every visit with no flash of the wrong theme.

  • Mobile responsive — sidebar collapses to hamburger menu below 1024px. Tables scroll horizontally on small screens with momentum scrolling on iOS. All interactive elements have a minimum 44px touch target.

  • Branding — custom primary color (drives all interactive states: links, active nav, TOC highlights, version selector, search focus ring), logo, font family (sans-serif, serif, or monospace), favicon, and custom CSS.

SEO

  • OG images — every page gets a unique Open Graph image (1200x630 JPEG) generated at publish time, used by social media, Slack, and other platforms that display link previews

  • Meta tags — title, description, og:title, og:description, og:image, and twitter:card (summary_large_image) on every page

  • XML sitemap — auto-generated at /sitemap.xml for search engine discovery

  • robots.txt — allows published content, blocks dashboard and API routes

  • Clean URLs — slug-based paths with no query parameters or file extensions

AI features

  • Embed widget — floating AI chat in the bottom-right corner (Pro, Team, and Business plans). Readers ask questions and get answers drawn from the published content.

  • llms.txt — machine-readable page index at /llms.txt following the llms.txt convention

  • Full-text Markdown — complete documentation as a single file at /llms-full.txt

  • Markdown sitemap — navigation-ordered page list at /sitemap.md with .md links

  • Per-page Markdown — individual pages available at /{slug}.md

  • Ask endpoint — /{slug}.md?ask={question} returns an AI-generated answer using the page and related content as context (5 requests/minute, Pro and above)

  • Smart 404 — .md requests for non-existent pages return suggested matches, links to sitemap.md and llms-full.txt, and usage instructions for AI tools

AI features like the embed widget, Ask endpoint, and smart 404 pages are designed to make your documentation directly consumable by AI agents and LLMs, in addition to human readers. The /llms.txt and /llms-full.txt endpoints follow emerging conventions for AI-readable content.

See also

Was this page helpful?