Using the Mardown block, you can render markdown directly on your documentation page.
- Select Markdown from the block menu.
- Insert a markdown file URL (with .md shortcut) into the file. Click Embed file.
Markdown content is visible in the published documentation only. You can also preview your documentation page to see an example of how it will look.
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.
Inserting markdown files from GitHub
- Open the markdown file inyour GitHub file browser, e.g. README.md
- Click on the Raw option from the file navigation bar (as seen on the image below).
- Copy the URL from the browser. It should start with https://raw.githubusercontent.com
We support GitHub Flavored Markdown format (e.g. tables or todo list)
Known limitations
- We do not currently support .mdx extension.
- Rendered markdown files are not indexed by search and Table of Contents.