Markdown sharing guides
Practical, step-by-step guides to sharing Markdown through a URL that looks right no matter what the recipient uses. Every guide has been checked against the current markdown.bz screens and specifications.
How to share a Markdown file as a URL
The basic steps for creating a share page from a .md file or pasted text, then sharing it with no expiry, an expiry date or a password.
How to share Markdown with images as a ZIP
Turn a README and its image folder into a single share page while keeping the relative paths intact. Covers folder structure, how to write the Markdown, and what to check when images cannot be found.
How to share a README with people outside GitHub
Give clients and reviewers who do not have a GitHub account a fixed URL where they can see how the README looks in their browser.
How to pass a Markdown share URL to AI
How AI finds the raw Markdown from a share page, the /raw URL that points to it reliably, and what to check when it cannot be fetched.
How to publish Markdown with the API, curl and GitHub Actions
Working examples that send Markdown from the command line or CI and get the share URL back. An official CLI and a public sample repository are also available.
How to share Mermaid diagrams and math in Markdown
A walkthrough of Mermaid diagrams and KaTeX math, from code examples to checking the preview and tracking down the cause when they do not render.
Markdown rendering examples
Fixed samples made by the markdown.bz team that show how tables, task lists, code, Mermaid and math actually render, so you can check before publishing.
Start sharing
If you already know the steps, you can create a share URL right away on the Upload page. For supported formats, expiry and safety notes, see Help / FAQ.
Last reviewed: / Reviewed by the markdown.bz team