Markdown Live Editor
Write structured documentation with a real-time preview. Ideal for README files for projects like emeraldcodestudios.com.
What is Markdown?
Markdown is a lightweight markup language with plain-text formatting syntax. It allows you to write using an easy-to-read, easy-to-write plain text format, which then converts to structurally valid HTML for the web.
Unlike traditional word processors, Markdown keeps you focused on your content rather than menus and formatting buttons.
Common Use Cases
- README Files: The standard for documenting GitHub projects like emeraldcodestudios.com.
- Technical Logs: Keeping track of server updates or project development milestones.
- Content Creation: Writing blog posts or website copy that needs to be converted to HTML.
- Notes & Documentation: Creating structured, platform-independent notes that work everywhere.
Pro Tips
- Line Breaks: Add two spaces at the end of a line for a simple carriage return.
- Horizontal Rules: Type
---on a new line to create a divider. - Images: Use
to embed visuals.
Quick Cheatsheet
# Header | Main Title |
**Bold** | Strong Text |
[Link](URL) | Hyperlink |
`Code` | Inline Code |
Writing Markdown with a live preview
Markdown gives you formatted output from plain text, which is why it has become the default for README files, documentation sites, static blogs and issue trackers. Type on the left, watch the rendered result on the right, and copy whichever version you need.
Syntax worth memorising
Headings use one to six hash characters followed by a space. Emphasis uses asterisks: one pair for italic, two for bold. Links follow the pattern [text](url), and images are the same with a leading exclamation mark.
Lists need a hyphen or asterisk and a space for bullets, or a number followed by a period for ordered lists. Indent by two or four spaces to nest a sub-list underneath.
Code can be inline using single backticks, or fenced as a block using three backticks. Adding a language name after the opening fence enables syntax highlighting on most platforms.
Flavours and portability
There is no single Markdown standard. The original specification is minimal, CommonMark tightened up the ambiguities, and GitHub Flavored Markdown adds tables, task lists, strikethrough and automatic linking on top.
That matters when you move a document between systems. Tables and task lists are widely supported but not universal, while footnotes, definition lists and inline HTML vary considerably. If a document must render identically everywhere, stay within the basics: headings, emphasis, lists, links and code.
Blank lines matter
Markdown needs an empty line between block elements. Most rendering surprises come from a missing one.
Two spaces for a line break
A single newline is ignored. End a line with two spaces to force a break inside a paragraph.
Escape with a backslash
To show a literal asterisk or underscore, put a backslash in front of it.
Frequently asked questions
Why is my table not rendering?
Tables are a GitHub Flavored Markdown extension, not part of the original specification. Confirm the destination platform supports them, and check that the header separator row uses at least three hyphens per column.
Can I use HTML inside Markdown?
Most renderers allow inline HTML, though many sanitise it for security. Anything relying on scripts or unusual attributes is likely to be stripped.
Is my document saved anywhere?
No. The editor runs in your browser and nothing is uploaded. Closing the tab discards the text, so copy anything you want to keep.
How do I add a line break without starting a paragraph?
End the line with two trailing spaces, or use a
tag if the renderer permits inline HTML.