What readers get

Every published site has the same, complete reading experience. You do not install a theme or configure a layout. This page lists what your readers see.

Layout#

• Banner displayed at the very top of the page, above the header, when configured.
• Header with your logo, your site name (if enabled or if there is no logo), the search bar, and the theme toggle. The logo switches to its dark version in dark mode if you have uploaded one.
• Sidebar listing every page. Pages in folders are grouped under the folder's name, and the page being read is highlighted in your brand color. Folders start collapsed unless they contain the current page, and readers can expand or collapse them.
• Article with the page title, the page actions menu, the page summary as a lead paragraph, and the text.
• On this page outline on wide screens, listing the page's ## and ### headings and marking the one being read.
• Previous and next links at the end of every page, in the order of the sidebar.
• Explore the docs on the home page: cards for the first eight other pages, with their summaries.
• On small screens the sidebar becomes a menu, and the outline is hidden.

Every page ends with the line "Documentation written with Docup", linked to docup.dev.

Page actions#

Beside the page title, a set of actions is available for sharing and analyzing the page:

• Copy page: Copies the entire page content as Markdown to the clipboard for use in LLMs.
• View as markdown: Opens the raw Markdown source of the page as plain text in a new tab.
• Open in ChatGPT, Claude, or Perplexity: Opens the selected AI assistant in a new tab with a prompt containing the page's markdown URL so readers can ask custom questions.

Search#

The search bar opens a search box. Open it from anywhere with Ctrl+K or Cmd+K, or by pressing / when you are not typing in a field.

• Results rank page titles first, then folder names, then page summaries. Every word you type must match somewhere.
• Up to eight results are shown. With an empty query, the first eight pages are listed.
• Move with the arrow keys, open with Enter and close with Esc.

Search covers titles, folders and summaries. It is fast because the page list is already in the browser. For questions that need page content, readers can use Ask AI.

Themes#

Readers can switch between light and dark mode with the toggle in the header, and the site remembers the choice in that browser. On the first visit the site follows your First visit setting: match the device, light or dark. See Appearance.

Code blocks#

Fenced code blocks are highlighted on the server, so readers download no highlighter. Each block shows its language in a header and has a Copy button. These languages are highlighted: Bash and shell, C, C++, C#, CSS, diff, Dockerfile, Go, GraphQL, INI and TOML, Java, JavaScript, JSON, Kotlin, Markdown, PHP, Python, Ruby, Rust, SQL, Swift, TypeScript, HTML, XML and Vue, and YAML. Blocks in other languages are shown as plain monospace text.

Headings and links#

• ## and ### headings get a # anchor link so a reader can share a section.
• Links to other pages of your docs, such as [Limits](/reference/limits), stay inside your site.
• Links to other sites open in a new tab.

Callouts and tables#

Notes, tips and warnings are drawn as highlighted boxes with an icon, and tables are styled and scroll sideways on narrow screens. See the Markdown reference.

Ask AI#

If Ask AI is on, a round Ask AI button floats in the lower right corner. It opens a chat panel with a text box, an option to stop generating, a clear button, and the pages used as sources for each answer. The chat history is kept in the browser's session storage, so it persists when readers navigate between pages or refresh, but is cleared when the tab is closed. A Turnstile bot-check is integrated to verify visitors. See Ask AI.

Accessibility and speed#

• Pages are server-rendered HTML, readable without scripts.
• Interactive elements have labels, and the search box and chat are operable from the keyboard.
• Pages that are the same for everyone are cached after the first view. See Performance.