Source for the Median documentation, built with Mintlify.
Median helps you build, publish, and maintain native iOS and Android apps powered by your web content. These docs cover building, configuring, and publishing apps with Median App Studio, the Median JavaScript Bridge, and native plugins.
- Errors in the docs: use the Raise issue button on any docs page, or open an issue in this repository.
- Help with your app: contact Median support. Issues in this repository are only for documentation.
| Path | Contents |
|---|---|
docs/ |
Documentation pages (MDX). A page's path is its URL, so docs/status-bar.mdx is served at /docs/status-bar. |
docs.json |
Site configuration: navigation, navbar, footer, and redirects |
snippets/ |
Reusable components, such as MedianLogo and AppetizeEmbed |
images/ |
Images used in the docs |
AGENTS.md |
Writing standards, brand rules, component patterns, and rules for contributors and AI tools |
docs/changelog.mdx and docs/changelog-archive.mdx are generated automatically every day. Don't edit them in this repository, because changes are overwritten on the next sync.
Read AGENTS.md before contributing. It covers the Median brand voice, terminology, style, page structure, components, logo and color rules, docs.json navigation rules, and common MDX errors that break the build.
AI coding tools such as Claude Code, Cursor, and Windsurf read AGENTS.md automatically. To also give them Mintlify's component reference and writing guidance, install the Mintlify skill:
npx skills add https://mintlify.com/docs-
Install the Mintlify CLI:
npm i -g mint
-
From the repository root, where
docs.jsonis located, start the preview:mint dev
-
Open
http://localhost:3000.
Run these before opening a pull request:
mint validate # MDX errors and content checks
mint broken-links # broken internal links- The preview doesn't start: run
mint updateto get the latest version of the CLI. - A page shows a 404: make sure you're running
mint devfrom the repository root, and that the page is listed indocs.jsonor that you're opening its exact path. - The build fails with "Expected the closing tag": a closing tag such as
</Warning>is indented under a list item. Move it to the start of the line.
Changes merged into main are deployed to docs.median.co by Mintlify. Open a pull request to get a preview deployment before merging.
The site's colors, fonts, and logos follow the Median Brand Guidelines. They're set in docs.json, changelog-tags.css, and images/median/. Don't change them in a pull request. The logo files come from the Median Brand Kit, and AGENTS.md lists the palette for anything custom.
The documentation content, including text, images, and the Median name and logo, is GoNative.io LLC dba Median.co. All rights reserved. Code samples in the documentation are available under the MIT License, so you can use them in your own apps. See LICENSE for details.