Skip to content
Median
Esc
↑↓navigate↵open⌘Jpreview
On this page

Site

A public help center, support chat and feedback board at your median.website address or your own domain.

Every organization gets a public site at https://<slug>.median.website. <slug> is the Slug under Settings → General. To serve it from your own address, connect a custom domain.

Section Public address Dashboard page
Help center /, /collections/<name>, /articles/<name>, /search Site → Help center
API reference /api-reference/<api>, /api-reference/<api>/<endpoint> Site → API reference
Support /support Site → Overview
Feedback /feedback, /feedback/<id> Site → Feedback

/ opens the help center. With the help center off, it opens the first section that is on.

Publish the site

Open the overview

Go to Site → Overview. Only admins and owners can change it.

Turn on sections

Under Sections, turn on Help center, Support and Feedback.

Publish

Turn on Publish site. Open goes to the address.

Every switch starts off. A section is public only while Publish site and its own switch are both on.

Help center

Articles are knowledge documents you publish. Nothing is public until you publish it.

Fact Detail
Publish Site → Help center. One switch per document, or Publish all per folder
Collections Each top-level folder is a collection. A folder inside it is a section of that collection
Not in a folder Listed on the home page under Articles
Address Set from the title when first published. Renaming the document keeps the address
Edits Show on the site as soon as they save. There is no second publish
Front matter Taken off the page. Its description shows under the title
MDX Components like <Steps> show their contents, with a title as a bold line. <TypeTable> becomes a table. Previews and other self-closing embeds are left out
Links Relative links and images point at the page the document is published on
Code Each block has a copy button. A fence’s title="..." shows over it
Search By meaning, from the knowledge base’s index, plus titles and words that match. Each search embeds the query, billed as Help center search
Ask The search box’s other mode, when Support is on. Sending opens the support page and the question becomes a message there, with any attached files
Popular articles The articles opened most. Until there are reads, the first ones in your library
Icons Every article, and every collection with no uploaded icon, gets an icon picked by AI from its words. A new title or folder name picks again. Billed as Help center icons

API reference

OpenAPI specs from your connected repositories as browsable references. Nothing is public until you publish it.

Fact Detail
Publish Site → API reference. One switch per spec. Needs the help center on
Navigation API reference joins the site’s sections. Its endpoints sit under their tags, folded, with the open endpoint’s tag expanded. Filter endpoints matches names, paths and methods
Groups Each tag is a group, in the order the spec lists its tags. An endpoint with no tag goes under the first word of its path
Front page The spec’s description, Base URL, Authentication, and every endpoint by group
Endpoint page Parameters by where they go, the body, and each response, with nested fields folded. A request in cURL, JavaScript and Python, and an example per response
Examples The spec’s own. Without one, a body example is built from the schema. x-codeSamples show as extra tabs
Address Set from the spec’s title when first found. An endpoint’s comes from its operationId, or its method and path
Updates Every sync that changes the spec file updates the reference. A removed file takes it off the site
Endpoint documents The per-endpoint knowledge documents stay out of Site → Help center, since the reference covers them. Ones published before stay listed

Support

A full-page chat with your agent. Conversations land in the inbox with a globe next to them, as the Help center channel.

Fact Detail
Agent The same agent, knowledge and tools as the widget
Composer The same box as the help center’s. It asks by default, and searches articles when the help center is on
Replies The agent’s are plain text with a copy button. People on your team reply in bubbles
Email Asked for before the first message when Ask for an email is on, unless the visitor is signed in
Signed in The chat follows them across devices. See Site sign-in
Screenshots and page directions Not offered. The agent knows it is on the help center

Feedback

A board of ideas customers vote on. Every idea is backed by a signal.

A customer posts an idea

They sign in first. The idea is read and filed as a signal, or joins a signal that says the same thing.

Review it

New ideas wait under Site → Feedback → Waiting for review. Edit changes the public title and description. Publish puts it on the board. Hide keeps it off.

Work the signal

The board shows the signal’s status. Change it on the signal as usual.

Signal status Board shows
Open Open
Planned Planned
In progress, In review In progress
Done Done
Declined Declined
Fact Detail
Votes One per signed in email address. Votes cast while an idea waits for review count once it is published
Roadmap Roadmap on the board lists Planned, In progress and Done
From Signal Suggestions from Signal lists open suggestions with no post. Add for review puts one in the queue
Merged signals Their posts merge. Votes from both carry over
Deleted signal Its post and votes are removed

Appearance

Site → Appearance changes how the site looks. Each row saves on its own and the preview reloads.

Setting Detail
Theme Paper or Console
Color scheme What a first visit opens in: Match the visitor, Light or Dark. Visitors can switch
Navigation Top bar, or Sidebar, which also lists your topics
Brand color A hex color. Reset goes back to the theme’s own
Custom CSS Loaded after the theme. See Site themes

Plan and access

Requirement Detail
Plan The Site add-on on Standard, or Pro. See Plans
Role Admins and owners change switches, articles, API references, the board, the look, the domain and sign-in
Branding “Powered by Median” shows in the footer unless your plan hides branding

Address rules

Case Result
Slug changed The site moves to the new address at once. The old address returns 404. A custom domain keeps working
Custom domain live <slug>.median.website redirects to it with a 308
Any other host 404, unless it is a live custom domain
Site off, section off, or plan without Site 404
The site cannot be reached 503, “This site could not be loaded. Please try again shortly.”

Changes to switches, articles, the board, the look, the domain and sign-in show in Logs as Help site changed.

Was this page helpful?