Guides
View as Markdown Open in ChatGPT Open in Claude

Doc Site Features

Every published Syntext site includes a set of reader-facing features out of the box. Nothing to install or configure — they're part of the build pipeline.

Page Feedback

Each page ends with a "Was this page helpful?" widget. Reader votes are collected per page and surface in your analytics dashboard and the Feedback API, helping you find pages that need work.

Previous / Next Navigation

Pages automatically link to their neighbors in the sidebar order, so readers can move through a section without returning to the navigation. The links follow your configured navigation groups.

Page Actions

Every page has an actions menu next to the title:

  • Copy page — copies the page as Markdown to the clipboard
  • View as Markdown — opens the raw .md export of the page
  • Open in ChatGPT — starts a ChatGPT conversation seeded with the page
  • Open in Claude — starts a Claude conversation seeded with the page

These are powered by per-page Markdown exports: every page.html has a matching page.md published alongside it.

AI-Readable Exports

Syntext sites publish machine-readable indexes for LLM tools:

File Contents
/llms.txt Index of all pages with titles and links
/llms-full.txt Full text of all pages in one file
/{page}.md Raw Markdown for any individual page

Point AI tools, crawlers, or the MCP server at these for accurate, up-to-date answers about your product.

Agentic Mode (Ask Page)

Agentic Mode is an add-on that gives your doc site a full-page agentic assistant at /ask — a conversational interface backed by the same RAG pipeline as the embedded widget. Enable it under Dashboard → Add-ons → Agentic Mode; toggling it triggers an automatic redeploy.

When enabled, visitors can switch modes from two places:

  • Docs ↔ Agent toggle — a sliding switch in the doc-site header. Click Agent and the pill slides across before the whole interface swaps to the full-page assistant; the same switch on the /ask page slides back to Docs.
  • Expand button — in the header of the slide-out assistant panel on any page.

What makes it agentic:

  • Conversation history — a sidebar lists the visitor's past conversations (grouped by date, searchable), restored from the server so a reload or a new tab picks up where they left off. Each conversation is titled from its first question.
  • Cross-conversation memory — the assistant distills durable facts from each exchange (e.g. the visitor's stack, use case, or experience level) and uses them to tailor answers in future conversations.
  • Multi-turn sessions — follow-up questions continue the same server-side session, so the model sees the full conversation context.

Memory and history are keyed by an anonymous visitor ID stored in the browser — no login required, and one visitor can never see another visitor's conversations. The persona, welcome message, and suggested questions all come from your AI assistant settings. Disabling the add-on removes the /ask page, the header toggle, and the panel expand button on the next deploy.

Full-text search is built in — press / or click the search box. Self-hosted builds include a static _assets/search-index.json so search works without the Syntext API (see stx build).

SEO Files

Builds generate sitemap.xml and robots.txt automatically from your navigation, plus per-page meta tags and Open Graph data from frontmatter.

Every production deploy also pings IndexNow automatically, so search engines that support it (Bing, DuckDuckGo, Yandex) re-crawl your changed pages immediately. The required key file is generated and hosted for you — no setup needed. Google discovers changes through the sitemap referenced in robots.txt.

HTTP status chips

A table whose first column is an HTTP status code renders each code as a coloured chip — green for 2xx, amber for 4xx, red for 5xx — using the theme's status tokens.

| Status | Meaning |
|--------|---------|
| 200    | Everything worked |
| 404    | Not found |
| 500    | Something went wrong on our end |

No component or configuration is needed: it triggers on content shape. Only first-column cells whose entire text is a 1xx–5xx code are affected, so a table that merely mentions a number is left alone.

Grouped search results

Cmd+K results are grouped by category — Endpoints, Guides, SDKs, Changelog, Pages — in a fixed order, so the list does not reshuffle as you type. Endpoint results show an HTTP method chip.

Category comes from the page path and frontmatter: pages under api/, api-reference/ or reference/ are endpoints, guides/, tutorial/ and getting-started/ are guides, and so on. Set category in a page's frontmatter to override.

Keyboard navigation still walks the full result list across groups.

Was this page helpful?