Complete Markdown Writing Guide with Suried Editor

Markdown 写作完全指南:用 Suried 编辑器高效创作

"Word is too heavy and formats aren't portable; plain text has no formatting. I want a lightweight writing format that uses plain text for headings, lists, code highlighting — but I'm not familiar with Markdown syntax."

Suried Markdown Editor provides live preview — write Markdown syntax on the left, see rendered output instantly on the right. This guide takes you from your first heading to mastering all common Markdown syntax in 10 minutes.

01 What Is Markdown?

Markdown is a lightweight markup language created by John Gruber in 2004. Its core philosophy: write in plain text, use simple symbols (like # for headings, ** for bold) for formatting, with excellent readability — content structure is clear even without rendering.

Markdown has become the de facto standard for technical writing — GitHub READMEs, tech blogs, API docs, note apps (Notion, Obsidian) all use Markdown. Learning Markdown means mastering a universal writing language.

Unlike rich text editors like Word/Pages, Markdown files are plain text (.md) — tiny file sizes, cross-platform compatible, version control friendly, and formatting never gets corrupted.

02 Basic Syntax: Headings, Bold, Italic

Headings use the # symbol. # Heading 1 (largest), ## Heading 2, ### Heading 3, down to ###### Heading 6. A space is required between # and text.

Bold uses double asterisks: **bold text**. Italic uses single asterisks: *italic text*. Bold italic uses triple asterisks: ***bold italic***. Underscores also work: __bold__, _italic_, but asterisks are the community convention.

Strikethrough uses double tildes: ~~deleted text~~. Inline code uses backticks: `console.log()`. Both are frequently used in technical documentation.

In Suried Editor, Ctrl+B toggles bold and Ctrl+I toggles italic, so you can format quickly without memorizing syntax.

03 Links & Images

Link syntax: [display text](URL). For example, [Google](https://google.com) renders as a clickable hyperlink. You can add a title after the URL: [Google](https://google.com "Search Engine").

Image syntax is similar to links with an exclamation mark prefix: ![alt text](image URL). For example, ![Logo](./logo.png). Alt text provides a fallback when images can't load and supports accessibility.

Reference links are great for reusing the same URL multiple times: define [site name]: URL first, then reference with [display text][site name]. This keeps link management clean in long documents.

04 Code Blocks

Inline code uses single backticks: `const x = 1`. Multi-line code blocks use triple backtick fences, with a language identifier after the opening backticks for syntax highlighting:

Supported language identifiers include: javascript / js, typescript / ts, python, html, css, json, bash / sh, sql, and more. Suried Editor supports syntax coloring for a wide range of languages.

If your code contains backticks, wrap inline code with double backticks: ``code with `backtick` ``. Everything inside a code block is displayed verbatim — Markdown rendering is suspended.

05 Lists & Tables

Unordered lists start with -, *, or + (- is recommended). Ordered lists use numbers with periods: 1., 2., 3.. Nested lists are created with indentation (2 or 4 spaces).

Task lists (TODO lists) use - [ ] for uncompleted and - [x] for completed items. Extremely useful in GitHub Issues and project management docs. Suried Editor renders them as interactive checkboxes.

Tables use pipes | to separate columns and --- to separate headers from content rows. Alignment is controlled with colons: :--- left-aligned, :---: centered, ---: right-aligned. While Markdown table syntax is verbose, Suried Editor's live preview lets you verify the result instantly.

Markdown tables aren't great for complex layouts (like merged cells). For complex tables, use HTML <table> tags directly — Markdown supports inline HTML.

FAQ

What's the relationship between Markdown and HTML?

Markdown is essentially converted to HTML for rendering. # Heading becomes <h1>Heading</h1>, **bold** becomes <strong>bold</strong>. Markdown is simplified HTML writing, and you can embed HTML tags directly in Markdown files.

Does Suried Markdown Editor support math formulas?

Yes, it supports KaTeX / LaTeX math formula syntax. Inline formulas use $: $E = mc^2$. Block formulas use $$. Perfect for writing technical documentation and academic notes.

Is Markdown syntax exactly the same across all platforms?

Core syntax (headings, bold, lists) is consistent everywhere. But platforms have their own extensions — GitHub Flavored Markdown (GFM) adds task lists, tables, strikethrough, etc.; CommonMark is the standardization effort. Suried Editor is GFM-compatible.

How do I create line breaks in Markdown?

In Markdown, pressing Enter once doesn't create a line break — you need two trailing spaces then Enter (hard break), or a blank line for a new paragraph. This is one of Markdown's most confusing design choices for beginners. Suried Editor's live preview clearly shows line break effects.

Can I use Markdown for books or long documents?

Absolutely! Many technical books are written in Markdown (Gitbook, mdBook, etc.). With table of contents generators, cross-references, and export tools, Markdown is fully capable for long-form writing. Suried Editor's export feature can convert Markdown to beautiful HTML or download as .md files.

✍️

Try the Tool Now

Suried Markdown Editor provides live preview — write Markdown syntax on the left, see rendered output instantly on the right. This guide takes you from your first heading to mastering all common Markdown syntax in 10 minutes.

TOOLS.SURIED.COM