{"id":564,"date":"2025-03-13T09:03:56","date_gmt":"2025-03-13T09:03:56","guid":{"rendered":"https:\/\/blog.devops955.com\/swain\/?p=564"},"modified":"2025-03-13T03:41:13","modified_gmt":"2025-03-13T03:41:13","slug":"markdown-syntax-summary","status":"publish","type":"post","link":"https:\/\/blog.devops955.com\/swain\/2025\/03\/13\/markdown-syntax-summary\/","title":{"rendered":"Markdown Syntax Summary"},"content":{"rendered":"<h2>Basic Syntax<\/h2>\n<h3>1. Headings<\/h3>\n<p>Use the <code>#<\/code> symbol to denote headings. The number of <code>#<\/code> symbols determines the heading level.<\/p>\n<pre><code class=\"language-markdown\"># Heading Level 1\n## Heading Level 2\n### Heading Level 3\n#### Heading Level 4\n##### Heading Level 5\n...<\/code><\/pre>\n<h3>2. Paragraphs and Line Breaks<\/h3>\n<p>Paragraphs should be separated by a blank line. Adding two spaces at the end of a line creates a line break.<\/p>\n<pre><code class=\"language-markdown\">This is the first line.  \nThis is the second line.<\/code><\/pre>\n<h3>3. Emphasis (Bold, Italic, Strikethrough)<\/h3>\n<pre><code class=\"language-markdown\">*Italic* or _Italic_\n**Bold** or __Bold__\n***Bold Italic*** or ___Bold Italic___\n~~Strikethrough~~<\/code><\/pre>\n<h3>4. Lists<\/h3>\n<ul>\n<li>Unordered lists use <code>-<\/code>, <code>+<\/code>, or <code>*<\/code><\/li>\n<li>Ordered lists use numbers followed by <code>.<\/code><\/li>\n<\/ul>\n<pre><code class=\"language-markdown\">- Unordered item 1\n- Unordered item 2\n\n1. Ordered item 1\n2. Ordered item 2<\/code><\/pre>\n<h3>5. Links and Images<\/h3>\n<pre><code class=\"language-markdown\">[Hyperlink](https:\/\/example.com)\n\n![Image](https:\/\/example.com\/image.png)<\/code><\/pre>\n<h3>6. Code Blocks<\/h3>\n<pre><code class=\"language-markdown\">`Inline code`\n\n    ```Code block (enclosed by three backticks)\n    Multiline code\n    ...\n    ```<\/code><\/pre>\n<h3>7. Blockquotes<\/h3>\n<pre><code class=\"language-markdown\">&gt; This is a blockquote.<\/code><\/pre>\n<h2>2. Advanced Syntax<\/h2>\n<h3>1. Tables<\/h3>\n<pre><code class=\"language-markdown\">| Header 1 | Header 2 |\n| -------- | -------- |\n| Cell 1   | Cell 2   |\n| Cell 3   | Cell 4   |<\/code><\/pre>\n<h3>2. Task Lists<\/h3>\n<pre><code class=\"language-markdown\">- [x] Completed item\n- [ ] Incomplete item<\/code><\/pre>\n<h3>3. HTML Support<\/h3>\n<p>Markdown supports certain HTML elements.<\/p>\n<pre><code class=\"language-html\">&lt;p style=&quot;color:red&quot;&gt;This is a red text.&lt;\/p&gt;<\/code><\/pre>\n<h2>3. Common Syntax Reference Table<\/h2>\n<table>\n<thead>\n<tr>\n<th>Syntax Type<\/th>\n<th>Markdown Syntax<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Heading<\/td>\n<td><code># Heading Level 1<\/code> <code>## Heading Level 2<\/code><\/td>\n<\/tr>\n<tr>\n<td>Bold<\/td>\n<td><code>**Bold**<\/code><\/td>\n<\/tr>\n<tr>\n<td>Italic<\/td>\n<td><code>*Italic*<\/code><\/td>\n<\/tr>\n<tr>\n<td>Strikethrough<\/td>\n<td><code>~~Strikethrough~~<\/code><\/td>\n<\/tr>\n<tr>\n<td>Hyperlink<\/td>\n<td><code>[Description](URL)<\/code><\/td>\n<\/tr>\n<tr>\n<td>Image<\/td>\n<td><code>![Description](URL)<\/code><\/td>\n<\/tr>\n<tr>\n<td>Unordered List<\/td>\n<td><code>- Item<\/code> or <code>* Item<\/code><\/td>\n<\/tr>\n<tr>\n<td>Ordered List<\/td>\n<td><code>1. Item<\/code><\/td>\n<\/tr>\n<tr>\n<td>Code Block<\/td>\n<td>\\<code>Inline code\\<\/code> or \\<code>\\<\/code>\\<code>Code block\\<\/code>\\<code>\\<\/code><\/td>\n<\/tr>\n<tr>\n<td>Task List<\/td>\n<td><code>- [x] Completed<\/code> <code>- [ ] Incomplete<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>The syntax above covers the officially supported Markdown features. Mastering these will be sufficient for most documentation needs.<\/p>\n<blockquote>\n<p>References:<br \/>\n<a href=\"https:\/\/www.markdownguide.org\/basic-syntax\/\">https:\/\/www.markdownguide.org\/basic-syntax\/<\/a><br \/>\n<a href=\"https:\/\/www.markdownguide.org\/extended-syntax\/\">https:\/\/www.markdownguide.org\/extended-syntax\/<\/a><br \/>\n<a href=\"https:\/\/www.markdownguide.org\/cheat-sheet\/\">https:\/\/www.markdownguide.org\/cheat-sheet\/<\/a><br \/>\n<a href=\"https:\/\/markdown.com.cn\/basic-syntax\/\">https:\/\/markdown.com.cn\/basic-syntax\/<\/a><br \/>\n<a href=\"https:\/\/markdown.com.cn\/extended-syntax\/\">https:\/\/markdown.com.cn\/extended-syntax\/<\/a>  <\/p>\n<\/blockquote>\n","protected":false},"excerpt":{"rendered":"<p>Markdown is a lightweight markup language widely used for writing documentation, README files, blog posts, and more. This article summarizes the officially supported Markdown syntax, categorized into basic syntax, advanced syntax, and a commonly used syntax reference table.<\/p>\n","protected":false},"author":3,"featured_media":558,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":"","_jetpack_memberships_contains_paid_content":false},"categories":[1],"tags":[],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"https:\/\/blog.devops955.com\/swain\/wp-content\/uploads\/sites\/2\/2025\/03\/Weixin-Image_20250313112831.png","_links":{"self":[{"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/posts\/564"}],"collection":[{"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/comments?post=564"}],"version-history":[{"count":3,"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/posts\/564\/revisions"}],"predecessor-version":[{"id":567,"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/posts\/564\/revisions\/567"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/media\/558"}],"wp:attachment":[{"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/media?parent=564"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/categories?post=564"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/tags?post=564"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}