06 / Markdown / markdown-editor
Markdown Editor
Edit Markdown with a toolbar, shortcuts and live preview.
How to use
- 01Start typing in the editor, or replace the sample document with your own text.
- 02Select some text and click a toolbar button (B, I, S, H1, H2, inline code, code block, Link, Img, bullet list, numbered list, Quote or horizontal rule) to wrap or prefix it with the matching Markdown syntax.
- 03Use keyboard shortcuts while typing: Ctrl/Cmd + B for bold, Ctrl/Cmd + I for italic, Ctrl/Cmd + E for inline code and Ctrl/Cmd + K for a link.
- 04Switch the View control between Write, Split and Preview to focus on the text, see both side by side, or check the rendered result.
- 05Keep an eye on the word and character count below the editor.
- 06Use Copy Markdown or Download .md to save your work as document.md, or Clear to start over.
What is this tool?
The Markdown Editor is a writing tool with a formatting toolbar, keyboard shortcuts and a live preview, so you can write Markdown without remembering every bit of syntax. Toolbar actions wrap your selection, or insert placeholder text when nothing is selected, and block elements like headings and lists always start on a new line. The preview uses the same sanitized GitHub Flavored Markdown rendering as the viewer, and everything runs locally in your browser.
Markdown keyboard shortcuts and toolbar
Four shortcuts cover the formatting you use most. Ctrl+B (Cmd+B on macOS) wraps the selection in double asterisks for bold, Ctrl+I adds single asterisks for italic, Ctrl+E wraps it in backticks for inline code, and Ctrl+K turns it into a link with a placeholder https:// URL.
If nothing is selected, inline actions insert the word "text" and select it so you can type over it. For example, pressing Ctrl+B on an empty line inserts **text** with "text" highlighted. Block actions like H2, Quote or the bullet list insert their prefix ("## ", "> " or "- ") and move to a new line first if your cursor is mid-line.
Write, Split and Preview modes
Split mode puts the editor and the rendered preview side by side on wide screens, which works well for most writing. Write mode hides the preview so you can draft without distraction, and Preview mode shows only the rendered document for a final read-through.
The editor has the browser's spell check turned on, and the word and character count updates as you type. That helps when a PR template, store listing or docs field has a length limit.
Saving your Markdown
The editor doesn't store drafts. When you're done, use Download .md to save a document.md file, or Copy Markdown to paste the source into GitHub, GitLab, a wiki or a ticket. Reloading the page brings back the sample document, so save anything you want to keep first.
Common use cases
- Drafting a README.md for a new project
- Writing pull request descriptions and release notes
- Composing bug reports and test summaries with code snippets
- Writing internal docs or wiki pages in Markdown
- Learning Markdown syntax by watching the toolbar insert it
FAQ
What are the keyboard shortcuts in the Markdown editor?
Ctrl/Cmd + B for bold, Ctrl/Cmd + I for italic, Ctrl/Cmd + E for inline code and Ctrl/Cmd + K for a link. Every other format is available from the toolbar.
Can I download my Markdown as a file?
Yes. Download .md saves your text as document.md, and Copy Markdown puts it on your clipboard.
Does the editor save my work automatically?
No. Nothing is stored or uploaded, so copy or download your text before closing or reloading the page.
Can I hide the preview while writing?
Yes. Set View to Write for the editor only, Preview for the rendered output only, or Split for both side by side.
Does the editor show a word count?
Yes. A live word and character count is shown below the editor.