Skip to content

Developers

Read and write Markdown documents

Open README files and specs in a clean reader, or write and store your own.

  1. Open Developer → Markdown Docs.
  2. Click Open .md files or drop one or more files on the page (.md, .markdown, .mdx or .txt, up to 5 MB). Files are read in your browser — nothing is uploaded until you save.
  3. Read with the On this page contents, reading progress, highlighted code (copy, wrap, line numbers), tables, task lists and GitHub alerts such as > [!NOTE]. Use the ⚙ button for text size, font, width and the contents sidebar.
  4. Remote images are hidden so image hosts can't see that you opened the document. Click Load images to show them.
  5. Click Save to vault to keep a document. It is encrypted on your device first (up to about 88 KB per document).
  6. Click New document, or Split / Edit on a saved one, to write Markdown with a live preview. Ctrl+S saves, Ctrl+B / Ctrl+I / Ctrl+K add bold, italic and links.
  7. Use ⋯ to copy the Markdown, download the .md file, pin it to the top or delete it.

Raw HTML inside Markdown is not shown, and links to other files in a repository only work in that repository.