[{"data":1,"prerenderedAt":1051},["ShallowReactive",2],{"guide-markdown-syntax-guide":3},{"id":4,"title":5,"body":6,"date":1044,"description":1045,"extension":544,"meta":1046,"navigation":348,"path":1047,"readingTime":79,"seo":1048,"stem":1049,"__hash__":1050},"guides\u002Fguides\u002Fmarkdown-syntax-guide.md","Markdown Syntax Guide: Complete Reference",{"type":7,"value":8,"toc":1012},"minimark",[9,14,18,21,25,36,83,93,97,100,195,202,206,211,224,254,258,261,281,285,296,316,320,324,355,359,374,377,380,384,387,396,400,403,433,436,440,548,552,558,587,590,594,597,622,625,647,650,654,657,677,680,684,687,702,739,743,747,766,770,785,789,792,801,805,857,861,971,975,996,1000,1008],[10,11,13],"h2",{"id":12},"what-is-markdown","What is Markdown?",[15,16,17],"p",{},"Markdown is a lightweight markup language that lets you write formatted content using plain text. Created by John Gruber in 2004, it has become the standard for documentation, READMEs, blog posts, and note-taking across the web.",[15,19,20],{},"The beauty of Markdown lies in its simplicity: what you type reads naturally as plain text, yet renders as rich HTML.",[10,22,24],{"id":23},"headings","Headings",[15,26,27,28,32,33,35],{},"Use ",[29,30,31],"code",{},"#"," symbols to create headings. The number of ",[29,34,31],{}," symbols sets the heading level.",[37,38,43],"pre",{"className":39,"code":40,"language":41,"meta":42,"style":42},"language-markdown shiki shiki-themes github-light github-dark","# Heading 1\n## Heading 2\n### Heading 3\n#### Heading 4\n##### Heading 5\n###### Heading 6\n","markdown","",[29,44,45,53,59,65,71,77],{"__ignoreMap":42},[46,47,50],"span",{"class":48,"line":49},"line",1,[46,51,52],{},"# Heading 1\n",[46,54,56],{"class":48,"line":55},2,[46,57,58],{},"## Heading 2\n",[46,60,62],{"class":48,"line":61},3,[46,63,64],{},"### Heading 3\n",[46,66,68],{"class":48,"line":67},4,[46,69,70],{},"#### Heading 4\n",[46,72,74],{"class":48,"line":73},5,[46,75,76],{},"##### Heading 5\n",[46,78,80],{"class":48,"line":79},6,[46,81,82],{},"###### Heading 6\n",[15,84,85,86,88,89,92],{},"Best practice: use one ",[29,87,31],{}," heading per document as the title, then start sections with ",[29,90,91],{},"##",".",[10,94,96],{"id":95},"emphasis","Emphasis",[15,98,99],{},"Add emphasis with asterisks or underscores:",[101,102,103,119],"table",{},[104,105,106],"thead",{},[107,108,109,113,116],"tr",{},[110,111,112],"th",{},"Syntax",[110,114,115],{},"Result",[110,117,118],{},"Use For",[120,121,122,143,162,179],"tbody",{},[107,123,124,134,140],{},[125,126,127,130,131],"td",{},[29,128,129],{},"*italic*"," or ",[29,132,133],{},"_italic_",[125,135,136],{},[137,138,139],"em",{},"italic",[125,141,142],{},"Light emphasis",[107,144,145,153,159],{},[125,146,147,130,150],{},[29,148,149],{},"**bold**",[29,151,152],{},"__bold__",[125,154,155],{},[156,157,158],"strong",{},"bold",[125,160,161],{},"Strong emphasis",[107,163,164,169,176],{},[125,165,166],{},[29,167,168],{},"***bold italic***",[125,170,171],{},[137,172,173],{},[156,174,175],{},"bold italic",[125,177,178],{},"Combined emphasis",[107,180,181,186,192],{},[125,182,183],{},[29,184,185],{},"~~strikethrough~~",[125,187,188],{},[189,190,191],"del",{},"strikethrough",[125,193,194],{},"Deleted text (GFM)",[15,196,197,198,201],{},"Tip: prefer asterisks (",[29,199,200],{},"*",") over underscores for consistency — they work in all contexts without spacing issues.",[10,203,205],{"id":204},"lists","Lists",[207,208,210],"h3",{"id":209},"unordered-lists","Unordered Lists",[15,212,27,213,216,217,219,220,223],{},[29,214,215],{},"-",", ",[29,218,200],{},", or ",[29,221,222],{},"+"," for bullet points:",[37,225,227],{"className":39,"code":226,"language":41,"meta":42,"style":42},"- First item\n- Second item\n  - Nested item\n  - Another nested item\n- Third item\n",[29,228,229,234,239,244,249],{"__ignoreMap":42},[46,230,231],{"class":48,"line":49},[46,232,233],{},"- First item\n",[46,235,236],{"class":48,"line":55},[46,237,238],{},"- Second item\n",[46,240,241],{"class":48,"line":61},[46,242,243],{},"  - Nested item\n",[46,245,246],{"class":48,"line":67},[46,247,248],{},"  - Another nested item\n",[46,250,251],{"class":48,"line":73},[46,252,253],{},"- Third item\n",[207,255,257],{"id":256},"ordered-lists","Ordered Lists",[15,259,260],{},"Use numbers followed by periods:",[37,262,264],{"className":39,"code":263,"language":41,"meta":42,"style":42},"1. First step\n2. Second step\n3. Third step\n",[29,265,266,271,276],{"__ignoreMap":42},[46,267,268],{"class":48,"line":49},[46,269,270],{},"1. First step\n",[46,272,273],{"class":48,"line":55},[46,274,275],{},"2. Second step\n",[46,277,278],{"class":48,"line":61},[46,279,280],{},"3. Third step\n",[207,282,284],{"id":283},"task-lists-gfm","Task Lists (GFM)",[15,286,287,288,291,292,295],{},"Add checkboxes with ",[29,289,290],{},"[ ]"," and ",[29,293,294],{},"[x]",":",[37,297,299],{"className":39,"code":298,"language":41,"meta":42,"style":42},"- [x] Write the guide\n- [ ] Review the draft\n- [ ] Publish the article\n",[29,300,301,306,311],{"__ignoreMap":42},[46,302,303],{"class":48,"line":49},[46,304,305],{},"- [x] Write the guide\n",[46,307,308],{"class":48,"line":55},[46,309,310],{},"- [ ] Review the draft\n",[46,312,313],{"class":48,"line":61},[46,314,315],{},"- [ ] Publish the article\n",[10,317,319],{"id":318},"links-and-images","Links and Images",[207,321,323],{"id":322},"links","Links",[37,325,327],{"className":39,"code":326,"language":41,"meta":42,"style":42},"[Link text](https:\u002F\u002Fexample.com)\n[Link with title](https:\u002F\u002Fexample.com \"Hover text\")\n[Reference link][ref]\n\n[ref]: https:\u002F\u002Fexample.com\n",[29,328,329,334,339,344,350],{"__ignoreMap":42},[46,330,331],{"class":48,"line":49},[46,332,333],{},"[Link text](https:\u002F\u002Fexample.com)\n",[46,335,336],{"class":48,"line":55},[46,337,338],{},"[Link with title](https:\u002F\u002Fexample.com \"Hover text\")\n",[46,340,341],{"class":48,"line":61},[46,342,343],{},"[Reference link][ref]\n",[46,345,346],{"class":48,"line":67},[46,347,349],{"emptyLinePlaceholder":348},true,"\n",[46,351,352],{"class":48,"line":73},[46,353,354],{},"[ref]: https:\u002F\u002Fexample.com\n",[207,356,358],{"id":357},"images","Images",[37,360,362],{"className":39,"code":361,"language":41,"meta":42,"style":42},"![Alt text describing the image](image.png)\n![Alt text](image.png \"Optional title\")\n",[29,363,364,369],{"__ignoreMap":42},[46,365,366],{"class":48,"line":49},[46,367,368],{},"![Alt text describing the image](image.png)\n",[46,370,371],{"class":48,"line":55},[46,372,373],{},"![Alt text](image.png \"Optional title\")\n",[15,375,376],{},"Always write descriptive alt text — it improves accessibility and SEO. Avoid vague descriptions like \"image\" or \"screenshot.\"",[10,378,379],{"id":29},"Code",[207,381,383],{"id":382},"inline-code","Inline Code",[15,385,386],{},"Wrap code in single backticks:",[37,388,390],{"className":39,"code":389,"language":41,"meta":42,"style":42},"Use the `console.log()` function to debug.\n",[29,391,392],{"__ignoreMap":42},[46,393,394],{"class":48,"line":49},[46,395,389],{},[207,397,399],{"id":398},"code-blocks","Code Blocks",[15,401,402],{},"Use triple backticks with an optional language hint for syntax highlighting:",[37,404,406],{"className":39,"code":405,"language":41,"meta":42,"style":42},"```javascript\nfunction greet(name) {\n  return `Hello, ${name}!`\n}\n```\n",[29,407,408,413,418,423,428],{"__ignoreMap":42},[46,409,410],{"class":48,"line":49},[46,411,412],{},"```javascript\n",[46,414,415],{"class":48,"line":55},[46,416,417],{},"function greet(name) {\n",[46,419,420],{"class":48,"line":61},[46,421,422],{},"  return `Hello, ${name}!`\n",[46,424,425],{"class":48,"line":67},[46,426,427],{},"}\n",[46,429,430],{"class":48,"line":73},[46,431,432],{},"```\n",[15,434,435],{},"Always specify the language. Syntax highlighting makes code significantly easier to read.",[207,437,439],{"id":438},"supported-language-hints","Supported Language Hints",[101,441,442,452],{},[104,443,444],{},[107,445,446,449],{},[110,447,448],{},"Hint",[110,450,451],{},"Language",[120,453,454,467,480,493,503,513,523,536],{},[107,455,456,464],{},[125,457,458,130,461],{},[29,459,460],{},"javascript",[29,462,463],{},"js",[125,465,466],{},"JavaScript",[107,468,469,477],{},[125,470,471,130,474],{},[29,472,473],{},"typescript",[29,475,476],{},"ts",[125,478,479],{},"TypeScript",[107,481,482,490],{},[125,483,484,130,487],{},[29,485,486],{},"python",[29,488,489],{},"py",[125,491,492],{},"Python",[107,494,495,500],{},[125,496,497],{},[29,498,499],{},"html",[125,501,502],{},"HTML",[107,504,505,510],{},[125,506,507],{},[29,508,509],{},"css",[125,511,512],{},"CSS",[107,514,515,520],{},[125,516,517],{},[29,518,519],{},"json",[125,521,522],{},"JSON",[107,524,525,533],{},[125,526,527,130,530],{},[29,528,529],{},"bash",[29,531,532],{},"shell",[125,534,535],{},"Shell\u002FBash",[107,537,538,545],{},[125,539,540,130,542],{},[29,541,41],{},[29,543,544],{},"md",[125,546,547],{},"Markdown",[10,549,551],{"id":550},"blockquotes","Blockquotes",[15,553,27,554,557],{},[29,555,556],{},">"," for blockquotes:",[37,559,561],{"className":39,"code":560,"language":41,"meta":42,"style":42},"> This is a blockquote.\n>\n> It can span multiple paragraphs.\n>\n> > And even nest.\n",[29,562,563,568,573,578,582],{"__ignoreMap":42},[46,564,565],{"class":48,"line":49},[46,566,567],{},"> This is a blockquote.\n",[46,569,570],{"class":48,"line":55},[46,571,572],{},">\n",[46,574,575],{"class":48,"line":61},[46,576,577],{},"> It can span multiple paragraphs.\n",[46,579,580],{"class":48,"line":67},[46,581,572],{},[46,583,584],{"class":48,"line":73},[46,585,586],{},"> > And even nest.\n",[15,588,589],{},"Blockquotes work well for callouts, notes, and quoted text.",[10,591,593],{"id":592},"tables","Tables",[15,595,596],{},"Create tables with pipes and hyphens:",[37,598,600],{"className":39,"code":599,"language":41,"meta":42,"style":42},"| Column 1 | Column 2 | Column 3 |\n|----------|:--------:|----------|\n| Left     | Center   | Right    |\n| Aligned  | Aligned  | Aligned  |\n",[29,601,602,607,612,617],{"__ignoreMap":42},[46,603,604],{"class":48,"line":49},[46,605,606],{},"| Column 1 | Column 2 | Column 3 |\n",[46,608,609],{"class":48,"line":55},[46,610,611],{},"|----------|:--------:|----------|\n",[46,613,614],{"class":48,"line":61},[46,615,616],{},"| Left     | Center   | Right    |\n",[46,618,619],{"class":48,"line":67},[46,620,621],{},"| Aligned  | Aligned  | Aligned  |\n",[15,623,624],{},"Alignment colons:",[626,627,628,635,641],"ul",{},[629,630,631,634],"li",{},[29,632,633],{},":---"," = left (default)",[629,636,637,640],{},[29,638,639],{},":---:"," = center",[629,642,643,646],{},[29,644,645],{},"---:"," = right",[15,648,649],{},"Keep tables simple. If a table gets too wide, consider a list instead.",[10,651,653],{"id":652},"horizontal-rules","Horizontal Rules",[15,655,656],{},"Use three or more hyphens, asterisks, or underscores:",[37,658,660],{"className":39,"code":659,"language":41,"meta":42,"style":42},"---\n***\n___\n",[29,661,662,667,672],{"__ignoreMap":42},[46,663,664],{"class":48,"line":49},[46,665,666],{},"---\n",[46,668,669],{"class":48,"line":55},[46,670,671],{},"***\n",[46,673,674],{"class":48,"line":61},[46,675,676],{},"___\n",[15,678,679],{},"All three render the same way. Choose one style and stick with it across your project.",[10,681,683],{"id":682},"escaping-characters","Escaping Characters",[15,685,686],{},"To display a literal Markdown character, precede it with a backslash:",[37,688,690],{"className":39,"code":689,"language":41,"meta":42,"style":42},"\\*Not italic\\*\n\\# Not a heading\n",[29,691,692,697],{"__ignoreMap":42},[46,693,694],{"class":48,"line":49},[46,695,696],{},"\\*Not italic\\*\n",[46,698,699],{"class":48,"line":55},[46,700,701],{},"\\# Not a heading\n",[15,703,704,705,216,708,216,711,216,713,216,716,216,719,216,722,216,725,216,727,216,729,216,731,216,733,216,736,92],{},"Characters you may need to escape: ",[29,706,707],{},"\\",[29,709,710],{},"`",[29,712,200],{},[29,714,715],{},"_",[29,717,718],{},"{}",[29,720,721],{},"[]",[29,723,724],{},"()",[29,726,31],{},[29,728,222],{},[29,730,215],{},[29,732,92],{},[29,734,735],{},"!",[29,737,738],{},"|",[10,740,742],{"id":741},"advanced-syntax","Advanced Syntax",[207,744,746],{"id":745},"footnotes","Footnotes",[37,748,750],{"className":39,"code":749,"language":41,"meta":42,"style":42},"Here is a claim.[^1]\n\n[^1]: This is the footnote content.\n",[29,751,752,757,761],{"__ignoreMap":42},[46,753,754],{"class":48,"line":49},[46,755,756],{},"Here is a claim.[^1]\n",[46,758,759],{"class":48,"line":55},[46,760,349],{"emptyLinePlaceholder":348},[46,762,763],{"class":48,"line":61},[46,764,765],{},"[^1]: This is the footnote content.\n",[207,767,769],{"id":768},"definition-lists-some-renderers","Definition Lists (some renderers)",[37,771,773],{"className":39,"code":772,"language":41,"meta":42,"style":42},"Term\n: Definition of the term\n",[29,774,775,780],{"__ignoreMap":42},[46,776,777],{"class":48,"line":49},[46,778,779],{},"Term\n",[46,781,782],{"class":48,"line":55},[46,783,784],{},": Definition of the term\n",[207,786,788],{"id":787},"heading-ids-and-links","Heading IDs and Links",[15,790,791],{},"Most renderers auto-generate IDs from headings. Link to them directly:",[37,793,795],{"className":39,"code":794,"language":41,"meta":42,"style":42},"[Jump to section](#heading-ids-and-links)\n",[29,796,797],{"__ignoreMap":42},[46,798,799],{"class":48,"line":49},[46,800,794],{},[10,802,804],{"id":803},"common-pitfalls","Common Pitfalls",[806,807,808,821,827,833,847],"ol",{},[629,809,810,813,814,816,817,820],{},[156,811,812],{},"Inconsistent heading levels"," — skip levels (e.g., ",[29,815,31],{}," to ",[29,818,819],{},"###",") and screen readers lose structure",[629,822,823,826],{},[156,824,825],{},"Missing alt text"," — images without descriptions fail accessibility checks",[629,828,829,832],{},[156,830,831],{},"No language hints"," — code blocks without a language lose syntax highlighting",[629,834,835,838,839,216,841,843,844,846],{},[156,836,837],{},"Mixed list markers"," — mixing ",[29,840,215],{},[29,842,200],{},", and ",[29,845,222],{}," in the same list creates inconsistency",[629,848,849,852,853,856],{},[156,850,851],{},"Trailing spaces for line breaks"," — two spaces at the end of a line create a ",[29,854,855],{},"\u003Cbr>",", but this is invisible in editors and easy to break accidentally",[10,858,860],{"id":859},"quick-reference","Quick Reference",[101,862,863,872],{},[104,864,865],{},[107,866,867,870],{},[110,868,869],{},"Element",[110,871,112],{},[120,873,874,884,893,902,912,922,931,941,951,961],{},[107,875,876,879],{},[125,877,878],{},"Heading",[125,880,881],{},[29,882,883],{},"## Heading",[107,885,886,889],{},[125,887,888],{},"Bold",[125,890,891],{},[29,892,149],{},[107,894,895,898],{},[125,896,897],{},"Italic",[125,899,900],{},[29,901,129],{},[107,903,904,907],{},[125,905,906],{},"Link",[125,908,909],{},[29,910,911],{},"[text](url)",[107,913,914,917],{},[125,915,916],{},"Image",[125,918,919],{},[29,920,921],{},"![alt](src)",[107,923,924,926],{},[125,925,379],{},[125,927,928],{},[29,929,930],{},"`code`",[107,932,933,936],{},[125,934,935],{},"Blockquote",[125,937,938],{},[29,939,940],{},"> quote",[107,942,943,946],{},[125,944,945],{},"List",[125,947,948],{},[29,949,950],{},"- item",[107,952,953,956],{},[125,954,955],{},"Table",[125,957,958],{},[29,959,960],{},"| col | col |",[107,962,963,966],{},[125,964,965],{},"HR",[125,967,968],{},[29,969,970],{},"---",[10,972,974],{"id":973},"related-guides","Related Guides",[626,976,977,984,990],{},[629,978,979],{},[980,981,983],"a",{"href":982},"\u002Fguides\u002Fmarkdown-best-practices","Markdown Best Practices",[629,985,986],{},[980,987,989],{"href":988},"\u002Fguides\u002Fmarkdown-extensions-explained","Markdown Extensions Explained",[629,991,992],{},[980,993,995],{"href":994},"\u002Fguides\u002Fplaceholder-text-best-practices","Placeholder Text Best Practices",[10,997,999],{"id":998},"try-it-yourself","Try It Yourself",[15,1001,1002,1003,1007],{},"Ready to put Markdown into practice? Use our free ",[980,1004,1006],{"href":1005},"\u002Ftools\u002Fmarkdown-to-html","Markdown to HTML Converter"," to write Markdown and see the rendered HTML output instantly.",[1009,1010,1011],"style",{},"html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":42,"searchDepth":55,"depth":55,"links":1013},[1014,1015,1016,1017,1022,1026,1031,1032,1033,1034,1035,1040,1041,1042,1043],{"id":12,"depth":55,"text":13},{"id":23,"depth":55,"text":24},{"id":95,"depth":55,"text":96},{"id":204,"depth":55,"text":205,"children":1018},[1019,1020,1021],{"id":209,"depth":61,"text":210},{"id":256,"depth":61,"text":257},{"id":283,"depth":61,"text":284},{"id":318,"depth":55,"text":319,"children":1023},[1024,1025],{"id":322,"depth":61,"text":323},{"id":357,"depth":61,"text":358},{"id":29,"depth":55,"text":379,"children":1027},[1028,1029,1030],{"id":382,"depth":61,"text":383},{"id":398,"depth":61,"text":399},{"id":438,"depth":61,"text":439},{"id":550,"depth":55,"text":551},{"id":592,"depth":55,"text":593},{"id":652,"depth":55,"text":653},{"id":682,"depth":55,"text":683},{"id":741,"depth":55,"text":742,"children":1036},[1037,1038,1039],{"id":745,"depth":61,"text":746},{"id":768,"depth":61,"text":769},{"id":787,"depth":61,"text":788},{"id":803,"depth":55,"text":804},{"id":859,"depth":55,"text":860},{"id":973,"depth":55,"text":974},{"id":998,"depth":55,"text":999},"2026-05-27","Master Markdown syntax with this comprehensive guide. Learn headings, links, images, code blocks, tables, and advanced features.",{"immutable":348},"\u002Fguides\u002Fmarkdown-syntax-guide",{"title":5,"description":1045},"guides\u002Fmarkdown-syntax-guide","_imDrB6YTEv2iDvyULzuz2jp2cA8PWpASnb8Y7yzamw",1780401325231]