Markdown

Render markdown directly on your documentation page.

Markdown block: Menu

Render a Markdown file

Markdown block: empty
  1. Select Markdown from the block menu.
  2. Insert a markdown file URL (with .md filetype). Click Embed file.

The fetched Markdown renders in the editor, so you can see how it will look on the page. You can also preview or publish the page as usual.

You can select the block style variant you prefer in the properties panel to the right of the editor — this determines how the block will appear in your published documentation.

Markdown block: property panel

If the source file changes, fetch the latest version from the block.

Search and MCP

The content of the Markdown file is available to Search and MCP, not only the source URL. That means files you maintain outside Supernova can be found in Search and used by AI tools connected through MCP, alongside the rest of your documentation.

Private Markdown files

For private files, connect the source in Workspace settings → Integrations. Markdown authentication uses the existing integrations for GitHub, GitLab, Bitbucket, and Azure DevOps.

Existing Markdown credentials from Documentation settings are migrated to Integration credentials where possible. If a credential can’t be migrated, reconnect the source through Integrations.

See Integrations for how to connect an account.

Inserting markdown files from GitHub

  1. Open the markdown file in your GitHub file browser, e.g. README.md
  2. Click on the Raw option from the file navigation bar (as seen on the image below).
  3. Copy the URL from the browser. It should start with https://raw.githubusercontent.com

The same URL workflow works for GitLab, Bitbucket, and Azure DevOps. Use a raw or file URL that points to the .md file, including a branch or other ref when the host requires one.

We support GitHub flavored markdown format (e.g. tables or todo list)

Known limitations

  • We do not currently support the .mdx extension.
  • Rendered markdown files are not included in the Table of Contents.
  • Markdown files are limited to 1 MB.