CINXE.COM

<!doctype html><html lang="en-US" prefix="og: https://ogp.me/ns#"><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><link rel="icon" href="https://developer.mozilla.org/favicon-48x48.bc390275e955dacb2e65.png"/><link rel="apple-touch-icon" href="https://developer.mozilla.org/apple-touch-icon.528534bba673c38049c2.png"/><meta name="theme-color" content="#ffffff"/><link rel="manifest" href="https://developer.mozilla.org/manifest.f42880861b394dd4dc9b.json"/><link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="MDN Web Docs"/><title>How to write in Markdown - The MDN Web Docs project | MDN</title><link rel="alternate" title="Anleitung zur Verwendung von Markdown" href="https://developer.mozilla.org/de/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" hrefLang="de"/><link rel="alternate" title="Cómo escribir en Markdown" href="https://developer.mozilla.org/es/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" hrefLang="es"/><link rel="alternate" title="Comment écrire du Markdown" href="https://developer.mozilla.org/fr/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" hrefLang="fr"/><link rel="alternate" title="Markdown の書き方" href="https://developer.mozilla.org/ja/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" hrefLang="ja"/><link rel="alternate" title="Como escrever em Markdown" href="https://developer.mozilla.org/pt-BR/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" hrefLang="pt"/><link rel="alternate" title="如何使用 Markdown 来撰写文档" href="https://developer.mozilla.org/zh-CN/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" hrefLang="zh"/><link rel="alternate" title="How to write in Markdown" href="https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" hrefLang="en"/><link rel="preload" as="font" type="font/woff2" href="/static/media/Inter.var.c2fe3cb2b7c746f7966a.woff2" crossorigin=""/><link rel="alternate" type="application/rss+xml" title="MDN Blog RSS Feed" href="https://developer.mozilla.org/en-US/blog/rss.xml" hrefLang="en"/><meta name="description" content="This page describes how we use Markdown to write documentation on MDN Web Docs. We have chosen GitHub-Flavored Markdown (GFM) as a baseline, and added some extensions to support some of the things we need to do on MDN that aren't readily supported in GFM."/><meta property="og:url" content="https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN"/><meta property="og:title" content="How to write in Markdown - The MDN Web Docs project | MDN"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:description" content="This page describes how we use Markdown to write documentation on MDN Web Docs. We have chosen GitHub-Flavored Markdown (GFM) as a baseline, and added some extensions to support some of the things we need to do on MDN that aren't readily supported in GFM."/><meta property="og:image" content="https://developer.mozilla.org/mdn-social-share.d893525a4fb5fb1f67a2.png"/><meta property="og:image:type" content="image/png"/><meta property="og:image:height" content="1080"/><meta property="og:image:width" content="1920"/><meta property="og:image:alt" content="The MDN Web Docs logo, featuring a blue accent color, displayed on a solid black background."/><meta property="og:site_name" content="MDN Web Docs"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:creator" content="MozDevNet"/><link rel="canonical" href="https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN"/><style media="print">.article-actions-container,.document-toc-container,.language-menu,.main-menu-toggle,.on-github,.page-footer,.place,.sidebar,.top-banner,.top-navigation-main,ul.prev-next{display:none!important}.main-page-content,.main-page-content pre{padding:2px}.main-page-content pre{border-left-width:2px}</style><script src="/static/js/gtag.js" defer=""></script><script defer="" src="/static/js/main.d21ae86f.js"></script><link href="/static/css/main.26c64ea7.css" rel="stylesheet"/></head><body><script>if(document.body.addEventListener("load",(t=>{t.target.classList.contains("interactive")&&t.target.setAttribute("data-readystate","complete")}),{capture:!0}),window&&document.documentElement){const t={light:"#ffffff",dark:"#1b1b1b"};try{const e=window.localStorage.getItem("theme");e&&(document.documentElement.className=e,document.documentElement.style.backgroundColor=t[e]);const o=window.localStorage.getItem("nop");o&&(document.documentElement.dataset.nop=o)}catch(t){console.warn("Unable to read theme from localStorage",t)}}</script><div id="root"><ul id="nav-access" class="a11y-nav"><li><a id="skip-main" href="#content">Skip to main content</a></li><li><a id="skip-search" href="#top-nav-search-input">Skip to search</a></li><li><a id="skip-select-language" href="#languages-switcher-button">Skip to select language</a></li></ul><div class="page-wrapper document-page"><div class="top-banner loading"><section class="place top container"></section></div><div class="sticky-header-container"><header class="top-navigation "><div class="container "><div class="top-navigation-wrap"><a href="/en-US/" class="logo" aria-label="MDN homepage"><svg id="mdn-docs-logo" xmlns="http://www.w3.org/2000/svg" x="0" y="0" viewBox="0 0 694.9 104.4" style="enable-background:new 0 0 694.9 104.4" xml:space="preserve" role="img"><title>MDN Web Docs</title><path d="M40.3 0 11.7 92.1H0L28.5 0h11.8zm10.4 0v92.1H40.3V0h10.4zM91 0 62.5 92.1H50.8L79.3 0H91zm10.4 0v92.1H91V0h10.4z" class="logo-m"></path><path d="M627.9 95.6h67v8.8h-67v-8.8z" class="logo-_"></path><path d="M367 42h-4l-10.7 30.8h-5.5l-10.8-26h-.4l-10.5 26h-5.2L308.7 42h-3.8v-5.6H323V42h-6.5l6.8 20.4h.4l10.3-26h4.7l11.2 26h.5l5.7-20.3h-6.2v-5.6H367V42zm34.9 20c-.4 3.2-2 5.9-4.7 8.2-2.8 2.3-6.5 3.4-11.3 3.4-5.4 0-9.7-1.6-13.1-4.7-3.3-3.2-5-7.7-5-13.7 0-5.7 1.6-10.3 4.7-14s7.4-5.5 12.9-5.5c5.1 0 9.1 1.6 11.9 4.7s4.3 6.9 4.3 11.3c0 1.5-.2 3-.5 4.7h-25.6c.3 7.7 4 11.6 10.9 11.6 2.9 0 5.1-.7 6.5-2 1.5-1.4 2.5-3 3-4.9l6 .9zM394 51.3c.2-2.4-.4-4.7-1.8-6.9s-3.8-3.3-7-3.3c-3.1 0-5.3 1-6.9 3-1.5 2-2.5 4.4-2.8 7.2H394zm51 2.4c0 5-1.3 9.5-4 13.7s-6.9 6.2-12.7 6.2c-6 0-10.3-2.2-12.7-6.7-.1.4-.2 1.4-.4 2.9s-.3 2.5-.4 2.9h-7.3c.3-1.7.6-3.5.8-5.3.3-1.8.4-3.7.4-5.5V22.3h-6v-5.6H416v27c1.1-2.2 2.7-4.1 4.7-5.7 2-1.6 4.8-2.4 8.4-2.4 4.6 0 8.4 1.6 11.4 4.7 3 3.2 4.5 7.6 4.5 13.4zm-7.7.6c0-4.2-1-7.4-3-9.5-2-2.2-4.4-3.3-7.4-3.3-3.4 0-6 1.2-8 3.7-1.9 2.4-2.9 5-3 7.7V57c0 3 1 5.6 3 7.7s4.5 3.1 7.6 3.1c3.6 0 6.3-1.3 8.1-3.9 1.8-2.7 2.7-5.9 2.7-9.6zm69.2 18.5h-13.2v-7.2c-1.2 2.2-2.8 4.1-4.9 5.6-2.1 1.6-4.8 2.4-8.3 2.4-4.8 0-8.7-1.6-11.6-4.9-2.9-3.2-4.3-7.7-4.3-13.3 0-5 1.3-9.6 4-13.7 2.6-4.1 6.9-6.2 12.8-6.2 5.7 0 9.8 2.2 12.3 6.5V22.3h-8.6v-5.6h15.8v50.6h6v5.5zM493.2 56v-4.4c-.1-3-1.2-5.5-3.2-7.3s-4.4-2.8-7.2-2.8c-3.6 0-6.3 1.3-8.2 3.9-1.9 2.6-2.8 5.8-2.8 9.6 0 4.1 1 7.3 3 9.5s4.5 3.3 7.4 3.3c3.2 0 5.8-1.3 7.8-3.8 2.1-2.6 3.1-5.3 3.2-8zm53.1-1.4c0 5.6-1.8 10.2-5.3 13.7s-8.2 5.3-13.9 5.3-10.1-1.7-13.4-5.1c-3.3-3.4-5-7.9-5-13.5 0-5.3 1.6-9.9 4.7-13.7 3.2-3.8 7.9-5.7 14.2-5.7s11 1.9 14.1 5.7c3 3.7 4.6 8.1 4.6 13.3zm-7.7-.2c0-4-1-7.2-3-9.5s-4.8-3.5-8.2-3.5c-3.6 0-6.4 1.2-8.3 3.7s-2.9 5.6-2.9 9.5c0 3.7.9 6.8 2.8 9.4 1.9 2.6 4.6 3.9 8.3 3.9 3.6 0 6.4-1.3 8.4-3.8 1.9-2.6 2.9-5.8 2.9-9.7zm45 5.8c-.4 3.2-1.9 6.3-4.4 9.1-2.5 2.9-6.4 4.3-11.8 4.3-5.2 0-9.4-1.6-12.6-4.8-3.2-3.2-4.8-7.7-4.8-13.7 0-5.5 1.6-10.1 4.7-13.9 3.2-3.8 7.6-5.7 13.2-5.7 2.3 0 4.6.3 6.7.8 2.2.5 4.2 1.5 6.2 2.9l1.5 9.5-5.9.7-1.3-6.1c-2.1-1.2-4.5-1.8-7.2-1.8-3.5 0-6.1 1.2-7.7 3.7-1.7 2.5-2.5 5.7-2.5 9.6 0 4.1.9 7.3 2.7 9.5 1.8 2.3 4.4 3.4 7.8 3.4 5.2 0 8.2-2.9 9.2-8.8l6.2 1.3zm34.7 1.9c0 3.6-1.5 6.5-4.6 8.5s-7 3-11.7 3c-5.7 0-10.6-1.2-14.6-3.6l1.2-8.8 5.7.6-.2 4.7c1.1.5 2.3.9 3.6 1.1s2.6.3 3.9.3c2.4 0 4.5-.4 6.5-1.3 1.9-.9 2.9-2.2 2.9-4.1 0-1.8-.8-3.1-2.3-3.8s-3.5-1.3-5.8-1.7-4.6-.9-6.9-1.4c-2.3-.6-4.2-1.6-5.7-2.9-1.6-1.4-2.3-3.5-2.3-6.3 0-4.1 1.5-6.9 4.6-8.5s6.4-2.4 9.9-2.4c2.6 0 5 .3 7.2.9 2.2.6 4.3 1.4 6.1 2.4l.8 8.8-5.8.7-.8-5.7c-2.3-1-4.7-1.6-7.2-1.6-2.1 0-3.7.4-5.1 1.1-1.3.8-2 2-2 3.8 0 1.7.8 2.9 2.3 3.6 1.5.7 3.4 1.2 5.7 1.6 2.2.4 4.5.8 6.7 1.4 2.2.6 4.1 1.6 5.7 3 1.4 1.6 2.2 3.7 2.2 6.6zM197.6 73.2h-17.1v-5.5h3.8V51.9c0-3.7-.7-6.3-2.1-7.9-1.4-1.6-3.3-2.3-5.7-2.3-3.2 0-5.6 1.1-7.2 3.4s-2.4 4.6-2.5 6.9v15.6h6v5.5h-17.1v-5.5h3.8V51.9c0-3.8-.7-6.4-2.1-7.9-1.4-1.5-3.3-2.3-5.6-2.3-3.2 0-5.5 1.1-7.2 3.3-1.6 2.2-2.4 4.5-2.5 6.9v15.8h6.9v5.5h-20.2v-5.5h6V42.4h-6.1v-5.6h13.4v6.4c1.2-2.1 2.7-3.8 4.7-5.2 2-1.3 4.4-2 7.3-2s5.3.7 7.5 2.1c2.2 1.4 3.7 3.5 4.5 6.4 1.1-2.5 2.7-4.5 4.9-6.1s4.8-2.4 7.9-2.4c3.5 0 6.5 1.1 8.9 3.3s3.7 5.6 3.7 10.2v18.2h6.1v5.5zm42.5 0h-13.2V66c-1.2 2.2-2.8 4.1-4.9 5.6-2.1 1.6-4.8 2.4-8.3 2.4-4.8 0-8.7-1.6-11.6-4.9-2.9-3.2-4.3-7.7-4.3-13.3 0-5 1.3-9.6 4-13.7 2.6-4.1 6.9-6.2 12.8-6.2s9.8 2.2 12.3 6.5V22.7h-8.6v-5.6h15.8v50.6h6v5.5zm-13.3-16.8V52c-.1-3-1.2-5.5-3.2-7.3s-4.4-2.8-7.2-2.8c-3.6 0-6.3 1.3-8.2 3.9-1.9 2.6-2.8 5.8-2.8 9.6 0 4.1 1 7.3 3 9.5s4.5 3.3 7.4 3.3c3.2 0 5.8-1.3 7.8-3.8 2.1-2.6 3.1-5.3 3.2-8zm61.5 16.8H269v-5.5h6V51.9c0-3.7-.7-6.3-2.2-7.9-1.4-1.6-3.4-2.3-5.7-2.3-3.1 0-5.6 1-7.4 3s-2.8 4.4-2.9 7v15.9h6v5.5h-19.3v-5.5h6V42.4h-6.2v-5.6h13.6V43c2.6-4.6 6.8-6.9 12.7-6.9 3.6 0 6.7 1.1 9.2 3.3s3.7 5.6 3.7 10.2v18.2h6v5.4h-.2z" class="logo-text"></path></svg></a><button title="Open main menu" type="button" class="button action has-icon main-menu-toggle" aria-haspopup="menu" aria-label="Open main menu" aria-expanded="false"><span class="button-wrap"><span class="icon icon-menu "></span><span class="visually-hidden">Open main menu</span></span></button></div><div class="top-navigation-main"><nav class="main-nav" aria-label="Main menu"><ul class="main-menu nojs"><li class="top-level-entry-container "><button type="button" id="references-button" class="top-level-entry menu-toggle" aria-controls="references-menu" aria-expanded="false">References</button><a href="/en-US/docs/Web" class="top-level-entry">References</a><ul id="references-menu" class="submenu references hidden inline-submenu-lg" aria-labelledby="references-button"><li class="apis-link-container mobile-only "><a href="/en-US/docs/Web" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview / Web Technology</div><p class="submenu-item-description">Web technology reference for developers</p></div></a></li><li class="html-link-container "><a href="/en-US/docs/Web/HTML" class="submenu-item "><div class="submenu-icon html"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTML</div><p class="submenu-item-description">Structure of content on the web</p></div></a></li><li class="css-link-container "><a href="/en-US/docs/Web/CSS" class="submenu-item "><div class="submenu-icon css"></div><div class="submenu-content-container"><div class="submenu-item-heading">CSS</div><p class="submenu-item-description">Code used to describe document style</p></div></a></li><li class="javascript-link-container "><a href="/en-US/docs/Web/JavaScript" class="submenu-item "><div class="submenu-icon javascript"></div><div class="submenu-content-container"><div class="submenu-item-heading">JavaScript</div><p class="submenu-item-description">General-purpose scripting language</p></div></a></li><li class="http-link-container "><a href="/en-US/docs/Web/HTTP" class="submenu-item "><div class="submenu-icon http"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTTP</div><p class="submenu-item-description">Protocol for transmitting web resources</p></div></a></li><li class="apis-link-container "><a href="/en-US/docs/Web/API" class="submenu-item "><div class="submenu-icon apis"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web APIs</div><p class="submenu-item-description">Interfaces for building web applications</p></div></a></li><li class="apis-link-container "><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web Extensions</div><p class="submenu-item-description">Developing extensions for web browsers</p></div></a></li><li class="apis-link-container desktop-only "><a href="/en-US/docs/Web" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web Technology</div><p class="submenu-item-description">Web technology reference for developers</p></div></a></li></ul></li><li class="top-level-entry-container "><button type="button" id="guides-button" class="top-level-entry menu-toggle" aria-controls="guides-menu" aria-expanded="false">Guides</button><a href="/en-US/docs/Learn" class="top-level-entry">Guides</a><ul id="guides-menu" class="submenu guides hidden inline-submenu-lg" aria-labelledby="guides-button"><li class="apis-link-container mobile-only "><a href="/en-US/docs/Learn" class="submenu-item "><div class="submenu-icon learn"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview / MDN Learning Area</div><p class="submenu-item-description">Learn web development</p></div></a></li><li class="apis-link-container desktop-only "><a href="/en-US/docs/Learn" class="submenu-item "><div class="submenu-icon learn"></div><div class="submenu-content-container"><div class="submenu-item-heading">MDN Learning Area</div><p class="submenu-item-description">Learn web development</p></div></a></li><li class="html-link-container "><a href="/en-US/docs/Learn/HTML" class="submenu-item "><div class="submenu-icon html"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTML</div><p class="submenu-item-description">Learn to structure web content with HTML</p></div></a></li><li class="css-link-container "><a href="/en-US/docs/Learn/CSS" class="submenu-item "><div class="submenu-icon css"></div><div class="submenu-content-container"><div class="submenu-item-heading">CSS</div><p class="submenu-item-description">Learn to style content using CSS</p></div></a></li><li class="javascript-link-container "><a href="/en-US/docs/Learn/JavaScript" class="submenu-item "><div class="submenu-icon javascript"></div><div class="submenu-content-container"><div class="submenu-item-heading">JavaScript</div><p class="submenu-item-description">Learn to run scripts in the browser</p></div></a></li><li class=" "><a href="/en-US/docs/Web/Accessibility" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Accessibility</div><p class="submenu-item-description">Learn to make the web accessible to all</p></div></a></li></ul></li><li class="top-level-entry-container "><button type="button" id="mdn-plus-button" class="top-level-entry menu-toggle" aria-controls="mdn-plus-menu" aria-expanded="false">Plus</button><a href="/en-US/plus" class="top-level-entry">Plus</a><ul id="mdn-plus-menu" class="submenu mdn-plus hidden inline-submenu-lg" aria-labelledby="mdn-plus-button"><li class=" "><a href="/en-US/plus" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview</div><p class="submenu-item-description">A customized MDN experience</p></div></a></li><li class=" "><a href="/en-US/plus/ai-help" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">AI Help</div><p class="submenu-item-description">Get real-time assistance and support</p></div></a></li><li class=" "><a href="/en-US/plus/updates" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Updates</div><p class="submenu-item-description">All browser compatibility updates at a glance</p></div></a></li><li class=" "><a href="/en-US/plus/docs/features/overview" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Documentation</div><p class="submenu-item-description">Learn how to use MDN Plus</p></div></a></li><li class=" "><a href="/en-US/plus/docs/faq" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">FAQ</div><p class="submenu-item-description">Frequently asked questions about MDN Plus</p></div></a></li></ul></li><li class="top-level-entry-container "><a class="top-level-entry menu-link" href="/en-US/curriculum/">Curriculum <sup class="new">New</sup></a></li><li class="top-level-entry-container "><a class="top-level-entry menu-link" href="/en-US/blog/">Blog</a></li><li class="top-level-entry-container "><button type="button" id="tools-button" class="top-level-entry menu-toggle" aria-controls="tools-menu" aria-expanded="false">Tools</button><ul id="tools-menu" class="submenu tools hidden inline-submenu-lg" aria-labelledby="tools-button"><li class=" "><a href="/en-US/play" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Playground</div><p class="submenu-item-description">Write, test and share your code</p></div></a></li><li class=" "><a href="/en-US/observatory" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTTP Observatory</div><p class="submenu-item-description">Scan a website for free</p></div></a></li><li class=" "><a href="/en-US/plus/ai-help" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">AI Help</div><p class="submenu-item-description">Get real-time assistance and support</p></div></a></li></ul></li></ul></nav><div class="header-search"><form action="/en-US/search" class="search-form search-widget" id="top-nav-search-form" role="search"><label id="top-nav-search-label" for="top-nav-search-input" class="visually-hidden">Search MDN</label><input aria-activedescendant="" aria-autocomplete="list" aria-controls="top-nav-search-menu" aria-expanded="false" aria-labelledby="top-nav-search-label" autoComplete="off" id="top-nav-search-input" role="combobox" type="search" class="search-input-field" name="q" placeholder=" " required="" value=""/><button type="button" class="button action has-icon clear-search-button"><span class="button-wrap"><span class="icon icon-cancel "></span><span class="visually-hidden">Clear search input</span></span></button><button type="submit" class="button action has-icon search-button"><span class="button-wrap"><span class="icon icon-search "></span><span class="visually-hidden">Search</span></span></button><div id="top-nav-search-menu" role="listbox" aria-labelledby="top-nav-search-label"></div></form></div><div class="theme-switcher-menu"><button type="button" class="button action has-icon theme-switcher-menu small" aria-haspopup="menu"><span class="button-wrap"><span class="icon icon-theme-os-default "></span>Theme</span></button></div><ul class="auth-container"><li><a href="/users/fxa/login/authenticate/?next=%2Fen-US%2Fdocs%2FMDN%2FWriting_guidelines%2FHowto%2FMarkdown_in_MDN" class="login-link" rel="nofollow">Log in</a></li><li><a href="/users/fxa/login/authenticate/?next=%2Fen-US%2Fdocs%2FMDN%2FWriting_guidelines%2FHowto%2FMarkdown_in_MDN" target="_self" rel="nofollow" class="button primary mdn-plus-subscribe-link"><span class="button-wrap">Sign up for free</span></a></li></ul></div></div></header><div class="article-actions-container"><div class="container"><button type="button" class="button action has-icon sidebar-button" aria-label="Expand sidebar" aria-expanded="false" aria-controls="sidebar-quicklinks"><span class="button-wrap"><span class="icon icon-sidebar "></span></span></button><nav class="breadcrumbs-container" aria-label="Breadcrumb"><ol typeof="BreadcrumbList" vocab="https://schema.org/" aria-label="breadcrumbs"><li property="itemListElement" typeof="ListItem"><a href="/en-US/docs/MDN" class="breadcrumb" property="item" typeof="WebPage"><span property="name">The MDN Web Docs project</span></a><meta property="position" content="1"/></li><li property="itemListElement" typeof="ListItem"><a href="/en-US/docs/MDN/Writing_guidelines" class="breadcrumb" property="item" typeof="WebPage"><span property="name">Writing guidelines</span></a><meta property="position" content="2"/></li><li property="itemListElement" typeof="ListItem"><a href="/en-US/docs/MDN/Writing_guidelines/Howto" class="breadcrumb" property="item" typeof="WebPage"><span property="name">How-to guides</span></a><meta property="position" content="3"/></li><li property="itemListElement" typeof="ListItem"><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" class="breadcrumb-current-page" property="item" typeof="WebPage"><span property="name">How to write in Markdown</span></a><meta property="position" content="4"/></li></ol></nav><div class="article-actions"><button type="button" class="button action has-icon article-actions-toggle" aria-label="Article actions"><span class="button-wrap"><span class="icon icon-ellipses "></span><span class="article-actions-dialog-heading">Article Actions</span></span></button><ul class="article-actions-entries"><li class="article-actions-entry"><div class="languages-switcher-menu open-on-focus-within"><button id="languages-switcher-button" type="button" class="button action small has-icon languages-switcher-menu" aria-haspopup="menu"><span class="button-wrap"><span class="icon icon-language "></span>English (US)</span></button><div class="hidden"><ul class="submenu language-menu " aria-labelledby="language-menu-button"><li class=" "><form class="submenu-item locale-redirect-setting"><div class="group"><label class="switch"><input type="checkbox" name="locale-redirect"/><span class="slider"></span><span class="label">Remember language</span></label><a href="https://github.com/orgs/mdn/discussions/739" rel="external noopener noreferrer" target="_blank" title="Enable this setting to automatically switch to this language when it's available. (Click to learn more.)"><span class="icon icon-question-mark "></span></a></div></form></li><li class=" "><a data-locale="de" href="/de/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" class="button submenu-item"><span>Deutsch</span><span title="Diese Übersetzung ist Teil eines Experiments."><span class="icon icon-experimental "></span></span></a></li><li class=" "><a data-locale="es" href="/es/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" class="button submenu-item"><span>Español</span></a></li><li class=" "><a data-locale="fr" href="/fr/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" class="button submenu-item"><span>Français</span></a></li><li class=" "><a data-locale="ja" href="/ja/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" class="button submenu-item"><span>日本語</span></a></li><li class=" "><a data-locale="pt-BR" href="/pt-BR/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" class="button submenu-item"><span>Português (do Brasil)</span></a></li><li class=" "><a data-locale="zh-CN" href="/zh-CN/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" class="button submenu-item"><span>中文 (简体)</span></a></li></ul></div></div></li></ul></div></div></div></div><div class="main-wrapper"><div class="sidebar-container"><aside id="sidebar-quicklinks" class="sidebar" data-macro="MDNSidebar"><button type="button" class="button action backdrop" aria-label="Collapse sidebar"><span class="button-wrap"></span></button><nav aria-label="Related Topics" class="sidebar-inner"><header class="sidebar-actions"><section class="sidebar-filter-container"><div class="sidebar-filter "><label id="sidebar-filter-label" class="sidebar-filter-label" for="sidebar-filter-input"><span class="icon icon-filter"></span><span class="visually-hidden">Filter sidebar</span></label><input id="sidebar-filter-input" autoComplete="off" class="sidebar-filter-input-field false" type="text" placeholder="Filter" value=""/><button type="button" class="button action has-icon clear-sidebar-filter-button"><span class="button-wrap"><span class="icon icon-cancel "></span><span class="visually-hidden">Clear filter input</span></span></button></div></section></header><div class="sidebar-inner-nav"><div class="in-nav-toc"><div class="document-toc-container"><section class="document-toc"><header><h2 class="document-toc-heading">In this article</h2></header><ul class="document-toc-list"><li class="document-toc-item "><a class="document-toc-link" href="#baseline_github-flavored_markdown">Baseline: GitHub-Flavored Markdown</a></li><li class="document-toc-item "><a class="document-toc-link" href="#links">Links</a></li><li class="document-toc-item "><a class="document-toc-link" href="#example_code_blocks">Example code blocks</a></li><li class="document-toc-item "><a class="document-toc-link" href="#notes_warnings_and_callouts">Notes, warnings, and callouts</a></li><li class="document-toc-item "><a class="document-toc-link" href="#definition_lists">Definition lists</a></li><li class="document-toc-item "><a class="document-toc-link" href="#tables">Tables</a></li><li class="document-toc-item "><a class="document-toc-link" href="#superscript_and_subscript">Superscript and subscript</a></li><li class="document-toc-item "><a class="document-toc-link" href="#page_summary">Page summary</a></li><li class="document-toc-item "><a class="document-toc-link" href="#kumascript">KumaScript</a></li></ul></section></div></div><div class="sidebar-body"><ol><li><a href="/en-US/docs/MDN">The MDN Web Docs project</a></li><li class="toggle"><details><summary>Community guidelines</summary><ol><li><a href="/en-US/docs/MDN/Community">Community guidelines</a></li><li class="toggle"><details><summary>Contributing to MDN Web Docs</summary><ol><li><a href="/en-US/docs/MDN/Community/Contributing">Contributing to MDN Web Docs</a></li><li><a href="/en-US/docs/MDN/Community/Contributing/Getting_started">Getting started with MDN Web Docs</a></li><li><a href="/en-US/docs/MDN/Community/Contributing/Our_repositories">MDN Web Docs Repositories</a></li><li><a href="/en-US/docs/MDN/Community/Contributing/Translated_content">MDN Web Docs Localization</a></li><li><a href="/en-US/docs/MDN/Community/Contributing/Security_vulnerability_response">Security vulnerability response steps</a></li></ol></details></li><li><a href="/en-US/docs/MDN/Community/Open_source_etiquette">Open source etiquette</a></li><li><a href="/en-US/docs/MDN/Community/Communication_channels">Communication channels</a></li><li><a href="/en-US/docs/MDN/Community/Discussions">Community discussions</a></li><li><a href="/en-US/docs/MDN/Community/Learn_forum">Learn forum</a></li><li><a href="/en-US/docs/MDN/Community/Issues">Guidelines to open and work on issues</a></li><li><a href="/en-US/docs/MDN/Community/Pull_requests">Pull request submission and review guidelines</a></li><li><a href="/en-US/docs/MDN/Community/Roles_teams">MDN Web Docs roles and teams</a></li></ol></details></li><li class="toggle"><details open=""><summary>Writing guidelines</summary><ol><li><a href="/en-US/docs/MDN/Writing_guidelines">Writing guidelines</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/What_we_write">What we write</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Writing_style_guide">Writing style guide</a></li><li class="toggle"><details open=""><summary>How-to guides</summary><ol><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto">How-to guides</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Images_media">How to add images and media</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting">How to create, move, delete, and edit pages</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Document_a_CSS_property">How to document a CSS property</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Document_an_HTTP_header">How to document an HTTP header</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Document_web_errors">How to document web errors</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Research_technology">How to research a technology</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data">How to use structured data</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference">How to write an API reference</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary">How to write an entry in the glossary</a></li><li><em><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" aria-current="page">How to write in Markdown</a></em></li></ol></details></li><li class="toggle"><details><summary>Page structures</summary><ol><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures">Page structures</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Banners_and_notices">Banners and notices</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Code_examples">Code examples</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables">Compatibility tables and the browser compatibility data repository (BCD)</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Live_samples">Live examples</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types">Page types</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Sidebars">Sidebars</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Specification_tables">Specification tables</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Syntax_sections">Syntax sections</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros">Using macros</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Feature_status">Feature status</a></li></ol></details></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Attrib_copyright_license">Attribution and copyright licensing</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete">Experimental, deprecated, and obsolete</a></li></ol></details></li><li class="toggle"><details><summary>Advisory Board</summary><ol><li><a href="/en-US/docs/MDN/MDN_Product_Advisory_Board">MDN Product Advisory Board</a></li><li><a href="/en-US/docs/MDN/MDN_Product_Advisory_Board/Membership">Product Advisory Board Charter & Membership</a></li></ol></details></li><li class="toggle"><details><summary>History</summary><ol><li><a href="/en-US/docs/MDN/At_ten">MDN at 10</a></li><li><a href="/en-US/docs/MDN/At_ten/History_of_MDN">The history of MDN</a></li></ol></details></li><li><a href="/en-US/docs/MDN/Changelog">MDN Web Docs changelog</a></li></ol></div></div><section class="place side"></section></nav></aside><div class="toc-container"><aside class="toc"><nav><div class="document-toc-container"><section class="document-toc"><header><h2 class="document-toc-heading">In this article</h2></header><ul class="document-toc-list"><li class="document-toc-item "><a class="document-toc-link" href="#baseline_github-flavored_markdown">Baseline: GitHub-Flavored Markdown</a></li><li class="document-toc-item "><a class="document-toc-link" href="#links">Links</a></li><li class="document-toc-item "><a class="document-toc-link" href="#example_code_blocks">Example code blocks</a></li><li class="document-toc-item "><a class="document-toc-link" href="#notes_warnings_and_callouts">Notes, warnings, and callouts</a></li><li class="document-toc-item "><a class="document-toc-link" href="#definition_lists">Definition lists</a></li><li class="document-toc-item "><a class="document-toc-link" href="#tables">Tables</a></li><li class="document-toc-item "><a class="document-toc-link" href="#superscript_and_subscript">Superscript and subscript</a></li><li class="document-toc-item "><a class="document-toc-link" href="#page_summary">Page summary</a></li><li class="document-toc-item "><a class="document-toc-link" href="#kumascript">KumaScript</a></li></ul></section></div></nav></aside><section class="place side"></section></div></div><main id="content" class="main-content "><article class="main-page-content" lang="en-US"><header><h1>How to write in Markdown</h1></header><div class="section-content"><p>This page describes how we use Markdown to write documentation on MDN Web Docs. We have chosen GitHub-Flavored Markdown (GFM) as a baseline, and added some extensions to support some of the things we need to do on MDN that aren't readily supported in GFM.</p></div><section aria-labelledby="baseline_github-flavored_markdown"><h2 id="baseline_github-flavored_markdown"><a href="#baseline_github-flavored_markdown">Baseline: GitHub-Flavored Markdown</a></h2><div class="section-content"><p>The baseline for MDN Markdown is GitHub-Flavored Markdown (GFM): <a href="https://github.github.com/gfm/" class="external" target="_blank">https://github.github.com/gfm/</a>. This means that you can refer to the GFM specification for anything not explicitly specified in this page. GFM in turn is a superset of CommonMark (<a href="https://spec.commonmark.org/" class="external" target="_blank">https://spec.commonmark.org/</a>).</p></div></section><section aria-labelledby="links"><h2 id="links"><a href="#links">Links</a></h2><div class="section-content"><p>The GFM specification defines two basic types of links:</p> <ul> <li><a href="https://github.github.com/gfm/#inline-link" class="external" target="_blank">inline links</a>, in which the destination is given immediately after the link text.</li> <li><a href="https://github.github.com/gfm/#reference-link" class="external" target="_blank">reference links</a>, in which the destination is defined elsewhere in the document.</li> </ul> <p>On MDN we allow only inline links.</p> <p>This is the correct way to write GFM links on MDN:</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md example-good notranslate"><code>[Macarons](https://en.wikipedia.org/wiki/Macaron) are delicious but tricky to make. </code></pre></div> <p>This is an incorrect way to write links on MDN:</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md example-bad notranslate"><code>[Macarons][macaron] are delicious but tricky to make. [macaron]: https://en.wikipedia.org/wiki/Macaron </code></pre></div></div></section><section aria-labelledby="example_code_blocks"><h2 id="example_code_blocks"><a href="#example_code_blocks">Example code blocks</a></h2><div class="section-content"><p>In GFM and CommonMark, authors can use "code fences" to demarcate <code><pre></code> blocks. The opening code fence may be followed by some text that is called the "info string". The specification states the following:</p> <blockquote> <p>The first word of the info string is typically used to specify the language of the code sample, and rendered in the class attribute of the code tag.</p> </blockquote> <p>It's permissible for the info string to contain multiple words, like:</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>```fee fi fo fum // some example code ``` </code></pre></div> <p>On MDN, writers will use code fences for example code blocks. They must specify the language of the code sample using the first word of the info string, and this will be used to provide syntax highlighting for the block. The following words are supported:</p> <ul> <li>Programming Languages <ul> <li>JavaScript <ul> <li><code>js</code> - JavaScript</li> <li><code>ts</code> - TypeScript</li> <li><code>jsx</code> - React JSX</li> <li><code>tsx</code> - React TSX</li> </ul> </li> <li>C-like <ul> <li><code>c</code> - C</li> <li><code>cpp</code> - C++</li> <li><code>cs</code> - C#</li> <li><code>java</code> - Java</li> </ul> </li> <li>Other <ul> <li><code>python</code> - Python</li> <li><code>php</code> - PHP</li> <li><code>rust</code> - Rust</li> <li><code>glsl</code> - GLSL (OpenGL Shaders)</li> <li><code>sql</code> - SeQueL commands</li> <li><code>wasm</code> - WebAssembly</li> <li><code>webidl</code> - Web Interface Definition Language</li> </ul> </li> </ul> </li> <li>Styling <ul> <li><code>css</code> - CSS</li> <li><code>scss</code> - Sass (SCSS)</li> <li><code>less</code> - Less</li> </ul> </li> <li>Markup <ul> <li><code>html</code> - HTML</li> <li><code>svg</code> - SVG</li> <li><code>xml</code> - XML</li> <li><code>mathml</code> - MathML</li> <li><code>md</code> - Markdown</li> <li><code>latex</code> - LaTeX</li> </ul> </li> <li>Command Prompts <ul> <li><code>bash</code> - Bash/Shell</li> <li><code>batch</code> - Batch (Windows Shell)</li> <li><code>powershell</code> - PowerShell</li> </ul> </li> <li>Configuration/Data Files <ul> <li><code>json</code> - JSON</li> <li><code>ini</code> - INI</li> <li><code>yaml</code> - YAML</li> <li><code>toml</code> - TOML</li> <li><code>sql</code> - SQL Database</li> <li><code>ignore</code> - Gitignore file</li> <li><code>apacheconf</code> - Apache configuration</li> <li><code>nginx</code> - NGINX configuration</li> </ul> </li> <li>Templates <ul> <li><code>django</code> - Django templates</li> <li><code>svelte</code> - Svelte templates</li> <li><code>handlebars</code> - Handlebars templates</li> <li><code>pug</code> - <a href="https://pugjs.org/api/getting-started.html" class="external" target="_blank">Pug templates</a> (which may be used by <a href="/en-US/docs/Learn/Server-side/Express_Nodejs/Displaying_data/Template_primer">Express</a>)</li> </ul> </li> <li>Other <ul> <li><code>plain</code> - Plain text</li> <li><code>diff</code> - Diff file</li> <li><code>http</code> - HTTP headers</li> <li><code>regex</code> - Regex</li> <li><code>uri</code> - URIs and URLs</li> </ul> </li> </ul> <p>For example:</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>```js const greeting = "I will get JavaScript syntax highlighting"; ``` </code></pre></div> <p> If the highlighting that you wish to use is not listed above, you should markup the code block as <code>plain</code>. Additional languages may be requested in the process <a href="https://github.com/orgs/mdn/discussions/170#discussioncomment-3404366" class="external" target="_blank">discussed on GitHub</a>. </p></div></section><section aria-labelledby="suppressing_linting"><h3 id="suppressing_linting"><a href="#suppressing_linting">Suppressing linting</a></h3><div class="section-content"><p>Writers can add a <code>-nolint</code> suffix to any of the language identifiers:</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>```html-nolint <p> I will not be linted. </p> ``` </code></pre></div> <p>Code blocks like this will get appropriate syntax highlighting and will be recognized by the live sample system, but will be ignored by linters or automatic formatters like Prettier. Authors should use this suffix for showing invalid code or alternative formatting that linters or formatters should not fix.</p></div></section><section aria-labelledby="additional_classes_info_strings"><h3 id="additional_classes_info_strings"><a href="#additional_classes_info_strings">Additional classes (info strings)</a></h3><div class="section-content"><p>GFM supports <a href="https://github.github.com/gfm/#info-string" class="external" target="_blank">info strings</a>, which allow authors to supply additional information about a code block. On MDN, info strings are converted into class names.</p> <p>Writers will be able to supply any one of the following info strings:</p> <ul> <li><code>example-good</code>: style this example as a good example (one to follow)</li> <li><code>example-bad</code>: style this example as a bad example (one to avoid)</li> <li><code>hidden</code>: don't render this code block in the page. This is for use in live samples.</li> </ul> <p>For example:</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>```js example-good const greeting = "I'm a good example"; ``` ```js example-bad const greeting = "I'm a bad example"; ``` ```js hidden const greeting = "I'm a secret greeting"; ``` </code></pre></div> <p>These will be rendered as:</p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js example-good notranslate"><code>const greeting = "I'm a good example"; </code></pre></div> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js example-bad notranslate"><code>const greeting = "I'm a bad example"; </code></pre></div></div></section><section aria-labelledby="discussion_reference"><h3 id="discussion_reference"><a href="#discussion_reference">Discussion reference</a></h3><div class="section-content"><p>This issue was resolved in:</p> <ul> <li><a href="https://github.com/mdn/content/issues/3512" class="external" target="_blank">https://github.com/mdn/content/issues/3512</a></li> <li><a href="https://github.com/mdn/yari/pull/7017" class="external" target="_blank">https://github.com/mdn/yari/pull/7017</a></li> </ul></div></section><section aria-labelledby="notes_warnings_and_callouts"><h2 id="notes_warnings_and_callouts"><a href="#notes_warnings_and_callouts">Notes, warnings, and callouts</a></h2><div class="section-content"><p>Writers can use the <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts" class="external" target="_blank">GFM alerts syntax</a> to call special attention to content. There are three types of alerts: notes, warnings, and callouts.</p> <div class="notecard note"> <p> <strong>Note:</strong> MDN Web Docs supported alerts with its own syntax prior to support for GFM alerts, and referred to them as "noteblocks". MDN does not support the following GFM alerts: <code>[!TIP]</code>, <code>[!CAUTION]</code>, <code>[!IMPORTANT]</code>. GFM does not support <code>[!CALLOUT]</code>. </p> </div> <ul> <li>To add a note, create a blockquote whose first line is <code>[!NOTE]</code>.</li> <li>To add a warning, create a blockquote whose first line is <code>[!WARNING]</code>.</li> <li>To add a callout, create a blockquote whose first line is <code>[!CALLOUT]</code>.</li> </ul> <p>Notes and warnings will add a localized <strong>Note:</strong> or <strong>Warning:</strong> to the beginning of the output, while callouts will not. This makes callouts a good choice when an author wants to provide a custom title.</p> <div class="notecard warning"> <p><strong>Warning:</strong> In the older MDN syntax, the type was localized and added to the first paragraph in bold text, i.e. <code>**Note:** Foo bar</code> instead of <code>[!NOTE] ⏎ Foo bar</code>.</p> <p>The older syntax is still supported for migration purposes. Avoid using it in new documentation.</p> </div> <div class="notecard warning"> <p><strong>Warning:</strong> Currently, due to a <a href="https://github.com/prettier/prettier/issues/15479" class="external" target="_blank">Prettier bug</a>, the GFM alert syntax cannot be used if the first character of a note or warning is a formatting symbol, such as a backquote, asterisk, square bracket or curly bracket. In this case, use the old syntax <code>> **Note:**</code> instead. Writers are not required to rephrase the content to work around the formatter.</p> </div> <p>Multiple lines are produced by an empty block quote line in the same way as normal paragraphs. Further, multiple lines without a space are also treated like normal Markdown lines, and concatenated.</p> <p>The blockquote can contain code blocks or other block elements.</p></div></section><section aria-labelledby="examples"><h3 id="examples"><a href="#examples">Examples</a></h3><div class="section-content"><h4 id="note">Note</h4> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>> [!NOTE] > This is how you write a note. > > It can have multiple lines. </code></pre></div> <p>This will produce the following HTML:</p> <div class="code-example"><div class="example-header"><span class="language-name">html</span></div><pre class="brush: html notranslate"><code><div class="notecard note"> <p><strong>Note:</strong> This is how you write a note.</p> <p>It can have multiple lines.</p> </div> </code></pre></div> <p>This HTML will be rendered as a highlighted box:</p> <div class="notecard note"> <p><strong>Note:</strong> This is how you write a note.</p> <p>It can have multiple lines.</p> </div> <h4 id="warnings">Warnings</h4> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>> [!WARNING] > This is how you write a warning. > > It can have multiple paragraphs. </code></pre></div> <p>This will produce the following HTML:</p> <div class="code-example"><div class="example-header"><span class="language-name">html</span></div><pre class="brush: html notranslate"><code><div class="notecard warning"> <p><strong>Warning:</strong> This is how you write a warning.</p> <p>It can have multiple paragraphs.</p> </div> </code></pre></div> <p>This HTML will be rendered as a highlighted box:</p> <div class="notecard warning"> <p><strong>Warning:</strong> This is how you write a warning.</p> <p>It can have multiple paragraphs.</p> </div> <h4 id="callouts">Callouts</h4> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>> [!CALLOUT] > > **This is how you write a callout.** > > It can have multiple paragraphs. </code></pre></div> <p>This will produce the following HTML:</p> <div class="code-example"><div class="example-header"><span class="language-name">html</span></div><pre class="brush: html notranslate"><code><div class="callout"> <p><strong>This is how you write a callout.</strong></p> <p>It can have multiple paragraphs.</p> </div> </code></pre></div> <p>This HTML will be rendered as a highlighted box:</p> <div class="callout"> <p><strong>This is how you write a callout.</strong></p> <p>It can have multiple paragraphs.</p> </div> <h4 id="note_containing_a_code_block">Note containing a code block</h4> <p>This example contains a code block.</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>> [!NOTE] > This is how you write a note. > > It can contain code blocks. > > ```js > const s = "I'm in a code block"; > ``` > > Like that. </code></pre></div> <p>This will produce the following HTML:</p> <div class="code-example"><div class="example-header"><span class="language-name">html</span></div><pre class="brush: html notranslate"><code><div class="notecard note"> <p><strong>Note:</strong> This is how you write a note.</p> <p>It can contain code blocks.</p> <pre class="brush: js">const s = "I'm in a code block";</pre> <p>Like that.</p> </div> </code></pre></div> <p>This HTML will be rendered as with a code block:</p> <div class="notecard note"> <p><strong>Note:</strong> This is how you write a note.</p> <p>It can contain code blocks.</p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>const s = "I'm in a code block"; </code></pre></div> <p>Like that.</p> </div></div></section><section aria-labelledby="discussion_reference_2"><h3 id="discussion_reference_2"><a href="#discussion_reference_2">Discussion reference</a></h3><div class="section-content"><p>This issue was resolved in <a href="https://github.com/mdn/content/issues/3483" class="external" target="_blank">https://github.com/mdn/content/issues/3483</a>.</p></div></section><section aria-labelledby="definition_lists"><h2 id="definition_lists"><a href="#definition_lists">Definition lists</a></h2><div class="section-content"><p>Definition lists are commonly used across MDN, but are not supported by GFM. MDN introduces a custom format for definition lists, which is a modified form of a GFM unordered list (<a href="/en-US/docs/Web/HTML/Element/ul"><code><ul></code></a>). In this format:</p> <ul> <li>The GFM <code><ul></code> contains any number of top-level GFM <code><li></code> elements.</li> <li>Each of these top-level GFM <code><li></code> elements must contain, as its final element, one GFM <code><ul></code> element.</li> <li>This final nested <code><ul></code> must contain a single GFM <code><li></code> element, whose text content must start with ": " (a colon followed by a space). This element may contain block elements, including paragraphs, code blocks, embedded lists, and notes.</li> </ul> <p>Each of these top-level GFM <code><li></code> elements will be transformed into a <code><dt></code>/<code><dd></code> pair, as follows:</p> <ul> <li>The top-level GFM <code><li></code> element will be parsed as a GFM <code><li></code> element and its internal contents will comprise the contents of the <code><dt></code>, except for the final nested <code><ul></code>, which will not be included in the <code><dt></code>.</li> <li>The <code><li></code> element in the final nested <code><ul></code> will be parsed as a GFM <code><li></code> element and its internal contents will comprise the contents of the <code><dd></code>, except for the leading ": ", which will be discarded.</li> </ul> <p>For example, this is a <code><dl></code>:</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>- term1 - : My description of term1 - `term2` - : My description of term2 It can have multiple paragraphs, and code blocks too: ```js const thing = 1; ``` </code></pre></div> <p>In GFM/CommonMark, this would produce the following HTML:</p> <div class="code-example"><div class="example-header"><span class="language-name">html</span></div><pre class="brush: html notranslate"><code><ul> <li> <p>term1</p> <ul> <li>: My description of term1</li> </ul> </li> <li> <p><code>term2</code></p> <ul> <li> <p>: My description of term2</p> <p>It can have multiple paragraphs, and code blocks too:</p> <pre> <code class="brush: js">const thing = 1;</code> </pre> </li> </ul> </li> </ul> </code></pre></div> <p>On MDN, this would produce the following HTML:</p> <div class="code-example"><div class="example-header"><span class="language-name">html</span></div><pre class="brush: html notranslate"><code><dl> <dt> <p>term1</p> </dt> <dd>My description of term1</dd> <dt> <p><code>term2</code></p> </dt> <dd> <p>My description of term2</p> <p>It can have multiple paragraphs, and code blocks too:</p> <pre> <code class="brush: js">const thing = 1;</code> </pre> </dd> </dl> </code></pre></div> <p>Definition lists written using this syntax must consist of pairs of <code><dt></code>/<code><dd></code> elements. Using this syntax, it's not possible to write a list with more than one consecutive <code><dt></code> element or more than one consecutive <code><dd></code> element: the parser will treat this as an error. We expect almost all definition lists on MDN will work with this limitation, and for those that do not, authors can fall back to raw HTML.</p> <p>This is not permitted:</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md example-bad notranslate"><code>- `param1`, `param2`, `param3` - : My description of `param1` - : My description of `param2` - : My description of `param3` </code></pre></div> <p>As a workaround for cases where an author needs to associate multiple <code><dt></code> items with a single <code><dd></code>, consider providing them as a single <code><dt></code> that holds multiple terms, separated by commas, like this:</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md example-good notranslate"><code>- `param1`, `param2`, `param3` - : My description of params 1, 2, and 3 </code></pre></div> <p>The rationale for the syntax described here is that it works well enough with tools that expect CommonMark (for example, Prettier or GitHub previews) while being reasonably easy to write and to parse.</p></div></section><section aria-labelledby="discussion_reference_3"><h3 id="discussion_reference_3"><a href="#discussion_reference_3">Discussion reference</a></h3><div class="section-content"><p>This issue was resolved in <a href="https://github.com/mdn/content/issues/4367" class="external" target="_blank">https://github.com/mdn/content/issues/4367</a>.</p></div></section><section aria-labelledby="tables"><h2 id="tables"><a href="#tables">Tables</a></h2><div class="section-content"><p>GFM provides a syntax for creating <a href="https://github.github.com/gfm/#tables-extension-" class="external" target="_blank">tables</a>, which we make use of in MDN. However, there are times when GFM tables do not suit our needs:</p> <ul> <li>The GFM syntax only supports a subset of the features available in HTML. If you need to use table features that are not supported in GFM, use HTML for the table.</li> <li>If the GFM representation of the table would be more than 150 characters wide, use HTML for the table.</li> <li>We support a special kind of table called a "properties table", which has its own CSS class and is therefore always HTML.</li> </ul> <p>So the general principle is that authors should use the GFM Markdown syntax when they can, and fall back to raw HTML when they have to or when HTML is more readable. For more information, see <a href="#when_to_use_html_tables">When to use HTML tables</a>.</p></div></section><section aria-labelledby="gfm_table_syntax_style"><h3 id="gfm_table_syntax_style"><a href="#gfm_table_syntax_style">GFM table syntax style</a></h3><div class="section-content"><p>In GFM table syntax, authors can omit leading and trailing pipes for rows. However, for the sake of readability, MDN authors must include these pipes. Additionally, authors must provide trailing spaces in rows, so that all cells in a column are the same length in plain text.</p> <p>That is, MDN authors must use this style:</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md example-good notranslate"><code>| Heading 1 | Heading 2 | Heading 3 | | --------- | --------- | --------- | | cell 1 | cell 2 | cell 3 | | cell 4 | cell 5 | cell 6 | </code></pre></div> <p>and not this style:</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md example-bad notranslate"><code>| Heading 1 | Heading 2 | Heading 3 | | --------- | --- |----------------------| | cell 1 | cell 2 | cell 3 | cell 4 | cell 5 | cell 6 </code></pre></div> <p>Luckily, table formatting is auto-fixed by Prettier, so authors may rely on Prettier to format their tables properly.</p></div></section><section aria-labelledby="when_to_use_html_tables"><h3 id="when_to_use_html_tables"><a href="#when_to_use_html_tables">When to use HTML tables</a></h3><div class="section-content"><p>There are three main circumstances in which authors should use HTML tables rather than GFM syntax:</p> <ol> <li>The table uses features that are not supported in GFM (see below).</li> <li>The GFM table would be too wide to be readable.</li> <li>The writer wants a special type of table called a "properties table".</li> </ol> <h4 id="table_features_that_are_not_supported_in_gfm">Table features that are not supported in GFM</h4> <p>The main limitations of GFM table syntax are:</p> <ul> <li>GFM tables must have a header row.</li> <li>GFM tables may not have a header column.</li> <li>GFM won't parse GFM block elements in table cells. For example, you can't have a list in a table cell.</li> <li>GFM tables cannot have classes assigned to them.</li> <li>GFM doesn't support any table elements beyond <code><table></code>, <code><tr></code>, <code><th></code>, and <code><td></code>.</li> <li>GFM doesn't support any table element attributes like <code>colspan</code>, <code>rowspan</code>, or <code>scope</code>.</li> </ul> <p>If an author needs to use any of the unsupported features, they should write the table in HTML.</p> <p>Note that we don't recommend the general use of <code><caption></code> elements on tables, since that would also rule out the GFM syntax.</p> <h4 id="gfm_table_maximum_width">GFM table maximum width</h4> <p>Even when a table could be written in GFM it is sometimes better to use HTML, because GFM uses an "<a href="/en-US/docs/Glossary/ASCII">ASCII</a> art" approach to tables that is not readable when table rows get long. Consider the following table:</p> <div class="code-example"><div class="example-header"><span class="language-name">html</span></div><pre class="brush: html notranslate"><code><table> <tr> <th>A heading 1</th> <th>A heading 2</th> <th>A heading 3</th> <th>A heading 4</th> <th>A heading 5</th> <th>A heading 6</th> </tr> <tr> <td>Something shortish</td> <td> Something much longer that really goes into a lot of detail about something, so much so that the table formatting starts to look bad in GFM format. </td> <td>Something shortish</td> <td> Another cell with lots of text in it, that also really goes into a lot of detail about something, so much so that the table formatting starts to look bad in GFM format. </td> <td>Something shortish</td> <td>Something shortish</td> </tr> </table> </code></pre></div> <p>In GFM this will look like:</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>| A heading 1 | A heading 2 | A heading 3 | A heading 4 | A heading 5 | A heading 6 | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | ------------------ | | Something shortish | Something much longer that really goes into a lot of detail about something, so much so that the table formatting starts to look bad in GFM format. | Something shortish | Another cell with lots of text in it, that also really goes into a lot of detail about something, so much so that the table formatting starts to look bad in GFM format. | Something shortish | Something shortish | </code></pre></div> <p>In a case like this it would be better to use HTML.</p> <p>This leads us to the following guideline: <em>if the Markdown representation of the table would be more than 150 characters wide, use HTML for the table</em>.</p> <h4 id="properties_tables">Properties tables</h4> <p>Properties tables are a specific type of table used for displaying structured property-value content across a set of pages of a particular type. These tables have two columns: the first column is the header column and lists the properties, and the second column lists their values for this particular item. For example, here's the properties table for the <a href="/en-US/docs/Web/API/PannerNode"><code>PannerNode</code></a> interface:</p> <figure class="table-container"><table class="properties"> <tbody> <tr> <th scope="row">Number of inputs</th> <td><code>1</code></td> </tr> <tr> <th scope="row">Number of outputs</th> <td><code>0</code></td> </tr> <tr> <th scope="row">Channel count mode</th> <td><code>"explicit"</code></td> </tr> <tr> <th scope="row">Channel count</th> <td><code>2</code></td> </tr> <tr> <th scope="row">Channel interpretation</th> <td><code>"speakers"</code></td> </tr> </tbody> </table></figure> <p> These pages can't be represented in GFM because they have a header column, so writers should use HTML in this case. To get the special styling, writers should apply the <code>"properties"</code> class to the table: </p> <div class="code-example"><div class="example-header"><span class="language-name">html</span></div><pre class="brush: html notranslate"><code><table class="properties"></table> </code></pre></div></div></section><section aria-labelledby="discussion_reference_4"><h3 id="discussion_reference_4"><a href="#discussion_reference_4">Discussion reference</a></h3><div class="section-content"><p>This issue was resolved in <a href="https://github.com/mdn/content/issues/4325" class="external" target="_blank">https://github.com/mdn/content/issues/4325</a>, <a href="https://github.com/mdn/content/issues/7342" class="external" target="_blank">https://github.com/mdn/content/issues/7342</a>, and <a href="https://github.com/mdn/content/issues/7898#issuecomment-913265900" class="external" target="_blank">https://github.com/mdn/content/issues/7898#issuecomment-913265900</a>.</p></div></section><section aria-labelledby="superscript_and_subscript"><h2 id="superscript_and_subscript"><a href="#superscript_and_subscript">Superscript and subscript</a></h2><div class="section-content"><p>Writers will be able to use the HTML <a href="/en-US/docs/Web/HTML/Element/sup"><code><sup></code></a> and <a href="/en-US/docs/Web/HTML/Element/sub"><code><sub></code></a> elements if necessary, but should use alternatives if possible. In particular:</p> <ul> <li>For exponentiation, use the caret: <code>2^53</code>.</li> <li>For ordinal expressions like 1<sup>st</sup>, prefer words like "first".</li> <li>For footnotes, don't mark up the footnote references, e.g., <code><sup>[1]</sup></code>.</li> </ul></div></section><section aria-labelledby="discussion_reference_5"><h3 id="discussion_reference_5"><a href="#discussion_reference_5">Discussion reference</a></h3><div class="section-content"><p>This issue was resolved in <a href="https://github.com/mdn/content/issues/4578" class="external" target="_blank">https://github.com/mdn/content/issues/4578</a>.</p></div></section><section aria-labelledby="page_summary"><h2 id="page_summary"><a href="#page_summary">Page summary</a></h2><div class="section-content"><p>The <em>page summary</em> is the first "content" paragraph in a page—the first text that appears after the page front matter and any <a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros/Commonly_used_macros#sidebar_generation">sidebar</a> or <a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros/Commonly_used_macros#page_or_section_header_indicators">page banner</a> macros.</p> <p> This summary is used for search engine optimization (SEO) and also automatically included alongside page listings by some macros. The first paragraph should therefore be both succinct and informative. </p></div></section><section aria-labelledby="discussion_reference_6"><h3 id="discussion_reference_6"><a href="#discussion_reference_6">Discussion reference</a></h3><div class="section-content"><p>This issue was resolved in <a href="https://github.com/mdn/content/issues/3923" class="external" target="_blank">https://github.com/mdn/content/issues/3923</a>.</p></div></section><section aria-labelledby="kumascript"><h2 id="kumascript"><a href="#kumascript">KumaScript</a></h2><div class="section-content"><p>Writers will be able to include KumaScript macro calls in prose content:</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>The **`margin`** [CSS](/en-US/docs/Web/CSS) property sets the margin area on all four sides of an element. It is a shorthand for {{cssxref("margin-top")}}, {{cssxref("margin-right")}}, {{cssxref("margin-bottom")}}, and {{cssxref("margin-left")}}. {{EmbedInteractiveExample("pages/css/margin.html")}} The top and bottom margins have no effect on replaced inline elements, such as {{HTMLElement("span")}} or {{HTMLElement("code")}}. </code></pre></div> <p>See <a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros">Using macros</a> for more information on macros.</p></div></section></article><aside class="article-footer"><div class="article-footer-inner"><div class="svg-container"><svg xmlns="http://www.w3.org/2000/svg" width="162" height="162" viewBox="0 0 162 162" fill="none" role="none"><mask id="b" fill="#fff"><path d="M97.203 47.04c8.113-7.886 18.004-13.871 28.906-17.492a78 78 0 0 1 33.969-3.39c11.443 1.39 22.401 5.295 32.024 11.411s17.656 14.28 23.476 23.86c5.819 9.579 9.269 20.318 10.083 31.385a69.85 69.85 0 0 1-5.387 32.44c-4.358 10.272-11.115 19.443-19.747 26.801-8.632 7.359-18.908 12.709-30.034 15.637l-6.17-21.698c7.666-2.017 14.746-5.703 20.694-10.773 5.948-5.071 10.603-11.389 13.606-18.467a48.14 48.14 0 0 0 3.712-22.352c-.561-7.625-2.938-15.025-6.948-21.625s-9.544-12.226-16.175-16.44-14.181-6.904-22.065-7.863a53.75 53.75 0 0 0-23.405 2.336c-7.513 2.495-14.327 6.62-19.918 12.053z"></path></mask><path stroke="url(#a)" stroke-dasharray="6, 6" stroke-width="2" d="M97.203 47.04c8.113-7.886 18.004-13.871 28.906-17.492a78 78 0 0 1 33.969-3.39c11.443 1.39 22.401 5.295 32.024 11.411s17.656 14.28 23.476 23.86c5.819 9.579 9.269 20.318 10.083 31.385a69.85 69.85 0 0 1-5.387 32.44c-4.358 10.272-11.115 19.443-19.747 26.801-8.632 7.359-18.908 12.709-30.034 15.637l-6.17-21.698c7.666-2.017 14.746-5.703 20.694-10.773 5.948-5.071 10.603-11.389 13.606-18.467a48.14 48.14 0 0 0 3.712-22.352c-.561-7.625-2.938-15.025-6.948-21.625s-9.544-12.226-16.175-16.44-14.181-6.904-22.065-7.863a53.75 53.75 0 0 0-23.405 2.336c-7.513 2.495-14.327 6.62-19.918 12.053z" mask="url(#b)" style="stroke:url(#a)" transform="translate(-63.992 -25.587)"></path><ellipse cx="8.066" cy="111.597" fill="var(--background-tertiary)" rx="53.677" ry="53.699" transform="matrix(.71707 -.697 .7243 .6895 0 0)"></ellipse><g clip-path="url(#c)" transform="translate(-63.992 -25.587)"><path fill="#9abff5" d="m144.256 137.379 32.906 12.434a4.41 4.41 0 0 1 2.559 5.667l-9.326 24.679a4.41 4.41 0 0 1-5.667 2.559l-8.226-3.108-2.332 6.17c-.466 1.233-.375 1.883-1.609 1.417l-2.253-.527c-.411-.155-.95-.594-1.206-1.161l-4.734-10.484-12.545-4.741a4.41 4.41 0 0 1-2.559-5.667l9.325-24.679a4.41 4.41 0 0 1 5.667-2.559m9.961 29.617 8.227 3.108 3.264-8.638-.498-6.768-4.113-1.555.548 7.258-4.319-1.632zm-12.339-4.663 8.226 3.108 3.264-8.637-.498-6.769-4.113-1.554.548 7.257-4.319-1.632z"></path></g><g clip-path="url(#d)" transform="translate(-63.992 -25.587)"><path fill="#81b0f3" d="M135.35 60.136 86.67 41.654c-3.346-1.27-7.124.428-8.394 3.775L64.414 81.938c-1.27 3.347.428 7.125 3.774 8.395l12.17 4.62-3.465 9.128c-.693 1.826-1.432 2.457.394 3.15l3.014 1.625c.609.231 1.637.274 2.477-.104l15.53-6.983 18.56 7.047c3.346 1.27 7.124-.428 8.395-3.775l13.862-36.51c1.27-3.346-.428-7.124-3.775-8.395M95.261 83.207l-12.17-4.62 4.852-12.779 7.19-7.017 6.085 2.31-7.725 7.51 6.389 2.426zm18.255 6.93-12.17-4.62 4.852-12.778 7.189-7.017 6.085 2.31-7.725 7.51 6.39 2.426z"></path></g><defs><clipPath id="c"><path fill="#fff" d="m198.638 146.586-65.056-24.583-24.583 65.057 65.056 24.582z"></path></clipPath><clipPath id="d"><path fill="#fff" d="m66.438 14.055 96.242 36.54-36.54 96.243-96.243-36.54z"></path></clipPath><linearGradient id="a" x1="97.203" x2="199.995" y1="47.04" y2="152.793" gradientUnits="userSpaceOnUse"><stop stop-color="#086DFC"></stop><stop offset="0.246" stop-color="#2C81FA"></stop><stop offset="0.516" stop-color="#5497F8"></stop><stop offset="0.821" stop-color="#80B0F6"></stop><stop offset="1" stop-color="#9ABFF5"></stop></linearGradient></defs></svg></div><h2>Help improve MDN</h2><fieldset class="feedback"><label>Was this page helpful to you?</label><div class="button-container"><button type="button" class="button primary has-icon yes"><span class="button-wrap"><span class="icon icon-thumbs-up "></span>Yes</span></button><button type="button" class="button primary has-icon no"><span class="button-wrap"><span class="icon icon-thumbs-down "></span>No</span></button></div></fieldset><a class="contribute" href="https://github.com/mdn/content/blob/main/CONTRIBUTING.md" title="This will take you to our contribution guidelines on GitHub." target="_blank" rel="noopener noreferrer">Learn how to contribute</a>.<p class="last-modified-date">This page was last modified on <time dateTime="2024-08-09T02:13:21.000Z">Aug 9, 2024</time> by <a href="/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN/contributors.txt" rel="nofollow">MDN contributors</a>.</p><div id="on-github" class="on-github"><a href="https://github.com/mdn/content/blob/main/files/en-us/mdn/writing_guidelines/howto/markdown_in_mdn/index.md?plain=1" title="Folder: en-us/mdn/writing_guidelines/howto/markdown_in_mdn (Opens in a new tab)" target="_blank" rel="noopener noreferrer">View this page on GitHub</a> • <a href="https://github.com/mdn/content/issues/new?template=page-report.yml&mdn-url=https%3A%2F%2Fdeveloper.mozilla.org%2Fen-US%2Fdocs%2FMDN%2FWriting_guidelines%2FHowto%2FMarkdown_in_MDN&metadata=%3C%21--+Do+not+make+changes+below+this+line+--%3E%0A%3Cdetails%3E%0A%3Csummary%3EPage+report+details%3C%2Fsummary%3E%0A%0A*+Folder%3A+%60en-us%2Fmdn%2Fwriting_guidelines%2Fhowto%2Fmarkdown_in_mdn%60%0A*+MDN+URL%3A+https%3A%2F%2Fdeveloper.mozilla.org%2Fen-US%2Fdocs%2FMDN%2FWriting_guidelines%2FHowto%2FMarkdown_in_MDN%0A*+GitHub+URL%3A+https%3A%2F%2Fgithub.com%2Fmdn%2Fcontent%2Fblob%2Fmain%2Ffiles%2Fen-us%2Fmdn%2Fwriting_guidelines%2Fhowto%2Fmarkdown_in_mdn%2Findex.md%0A*+Last+commit%3A+https%3A%2F%2Fgithub.com%2Fmdn%2Fcontent%2Fcommit%2F487085d8bbd6d80719e6c28ade98563479727df7%0A*+Document+last+modified%3A+2024-08-09T02%3A13%3A21.000Z%0A%0A%3C%2Fdetails%3E" title="This will take you to GitHub to file a new issue." target="_blank" rel="noopener noreferrer">Report a problem with this content</a></div></div></aside></main></div></div><footer id="nav-footer" class="page-footer"><div class="page-footer-grid"><div class="page-footer-logo-col"><a href="/" class="mdn-footer-logo" aria-label="MDN homepage"><svg width="48" height="17" viewBox="0 0 48 17" fill="none" xmlns="http://www.w3.org/2000/svg"><title id="mdn-footer-logo-svg">MDN logo</title><path d="M20.04 16.512H15.504V10.416C15.504 9.488 15.344 8.824 15.024 8.424C14.72 8.024 14.264 7.824 13.656 7.824C12.92 7.824 12.384 8.064 12.048 8.544C11.728 9.024 11.568 9.64 11.568 10.392V14.184H13.008V16.512H8.472V10.416C8.472 9.488 8.312 8.824 7.992 8.424C7.688 8.024 7.232 7.824 6.624 7.824C5.872 7.824 5.336 8.064 5.016 8.544C4.696 9.024 4.536 9.64 4.536 10.392V14.184H6.6V16.512H0V14.184H1.44V8.04H0.024V5.688H4.536V7.32C5.224 6.088 6.32 5.472 7.824 5.472C8.608 5.472 9.328 5.664 9.984 6.048C10.64 6.432 11.096 7.016 11.352 7.8C11.992 6.248 13.168 5.472 14.88 5.472C15.856 5.472 16.72 5.776 17.472 6.384C18.224 6.992 18.6 7.936 18.6 9.216V14.184H20.04V16.512Z" fill="currentColor"></path><path d="M33.6714 16.512H29.1354V14.496C28.8314 15.12 28.3834 15.656 27.7914 16.104C27.1994 16.536 26.4154 16.752 25.4394 16.752C24.0154 16.752 22.8954 16.264 22.0794 15.288C21.2634 14.312 20.8554 12.984 20.8554 11.304C20.8554 9.688 21.2554 8.312 22.0554 7.176C22.8554 6.04 24.0634 5.472 25.6794 5.472C26.5594 5.472 27.2794 5.648 27.8394 6C28.3994 6.352 28.8314 6.8 29.1354 7.344V2.352H26.9754V0H32.2314V14.184H33.6714V16.512ZM29.1354 11.04V10.776C29.1354 9.88 28.8954 9.184 28.4154 8.688C27.9514 8.176 27.3674 7.92 26.6634 7.92C25.9754 7.92 25.3674 8.176 24.8394 8.688C24.3274 9.2 24.0714 10.008 24.0714 11.112C24.0714 12.152 24.3114 12.944 24.7914 13.488C25.2714 14.032 25.8394 14.304 26.4954 14.304C27.3114 14.304 27.9514 13.96 28.4154 13.272C28.8954 12.584 29.1354 11.84 29.1354 11.04Z" fill="currentColor"></path><path d="M47.9589 16.512H41.9829V14.184H43.4229V10.416C43.4229 9.488 43.2629 8.824 42.9429 8.424C42.6389 8.024 42.1829 7.824 41.5749 7.824C40.8389 7.824 40.2709 8.056 39.8709 8.52C39.4709 8.968 39.2629 9.56 39.2469 10.296V14.184H40.6869V16.512H34.7109V14.184H36.1509V8.04H34.5909V5.688H39.2469V7.344C39.9669 6.096 41.1269 5.472 42.7269 5.472C43.7509 5.472 44.6389 5.776 45.3909 6.384C46.1429 6.992 46.5189 7.936 46.5189 9.216V14.184H47.9589V16.512Z" fill="currentColor"></path></svg></a><p>Your blueprint for a better internet.</p><ul class="social-icons"><li><a href="https://mozilla.social/@mdn" target="_blank" rel="me noopener noreferrer"><span class="icon icon-mastodon"></span><span class="visually-hidden">MDN on Mastodon</span></a></li><li><a href="https://twitter.com/mozdevnet" target="_blank" rel="noopener noreferrer"><span class="icon icon-twitter-x"></span><span class="visually-hidden">MDN on X (formerly Twitter)</span></a></li><li><a href="https://github.com/mdn/" target="_blank" rel="noopener noreferrer"><span class="icon icon-github-mark-small"></span><span class="visually-hidden">MDN on GitHub</span></a></li><li><a href="/en-US/blog/rss.xml" target="_blank"><span class="icon icon-feed"></span><span class="visually-hidden">MDN Blog RSS Feed</span></a></li></ul></div><div class="page-footer-nav-col-1"><h2 class="footer-nav-heading">MDN</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a href="/en-US/about">About</a></li><li class="footer-nav-item"><a href="/en-US/blog/">Blog</a></li><li class="footer-nav-item"><a href="https://www.mozilla.org/en-US/careers/listings/?team=ProdOps" target="_blank" rel="noopener noreferrer">Careers</a></li><li class="footer-nav-item"><a href="/en-US/advertising">Advertise with us</a></li></ul></div><div class="page-footer-nav-col-2"><h2 class="footer-nav-heading">Support</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="https://support.mozilla.org/products/mdn-plus">Product help</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/docs/MDN/Community/Issues">Report an issue</a></li></ul></div><div class="page-footer-nav-col-3"><h2 class="footer-nav-heading">Our communities</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/community">MDN Community</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="https://discourse.mozilla.org/c/mdn/236" target="_blank" rel="noopener noreferrer">MDN Forum</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/discord" target="_blank" rel="noopener noreferrer">MDN Chat</a></li></ul></div><div class="page-footer-nav-col-4"><h2 class="footer-nav-heading">Developers</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/docs/Web">Web Technologies</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/docs/Learn">Learn Web Development</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/plus">MDN Plus</a></li><li class="footer-nav-item"><a href="https://hacks.mozilla.org/" target="_blank" rel="noopener noreferrer">Hacks Blog</a></li></ul></div><div class="page-footer-moz"><a href="https://www.mozilla.org/" class="footer-moz-logo-link" target="_blank" rel="noopener noreferrer"><svg width="112" height="32" fill="none" xmlns="http://www.w3.org/2000/svg"><title id="mozilla-footer-logo-svg">Mozilla logo</title><path d="M41.753 14.218c-2.048 0-3.324 1.522-3.324 4.157 0 2.423 1.119 4.286 3.29 4.286 2.082 0 3.447-1.678 3.447-4.347 0-2.826-1.522-4.096-3.413-4.096Zm54.89 7.044c0 .901.437 1.618 1.645 1.618 1.427 0 2.949-1.024 3.044-3.352-.649-.095-1.365-.185-2.02-.185-1.426-.005-2.668.397-2.668 1.92Z" fill="currentColor"></path><path d="M0 0v32h111.908V0H0Zm32.56 25.426h-5.87v-7.884c0-2.423-.806-3.352-2.39-3.352-1.924 0-2.702 1.365-2.702 3.324v4.868h1.864v3.044h-5.864v-7.884c0-2.423-.806-3.352-2.39-3.352-1.924 0-2.702 1.365-2.702 3.324v4.868h2.669v3.044H6.642v-3.044h1.863v-7.918H6.642V11.42h5.864v2.11c.839-1.489 2.3-2.39 4.252-2.39 2.02 0 3.878.963 4.566 3.01.778-1.862 2.361-3.01 4.566-3.01 2.512 0 4.812 1.522 4.812 4.84v6.402h1.863v3.044h-.005Zm9.036.307c-4.314 0-7.296-2.635-7.296-7.106 0-4.096 2.484-7.481 7.514-7.481s7.481 3.38 7.481 7.29c0 4.472-3.228 7.297-7.699 7.297Zm22.578-.307H51.942l-.403-2.11 7.7-8.846h-4.376l-.621 2.17-2.888-.313.498-4.907h12.294l.313 2.11-7.767 8.852h4.533l.654-2.172 3.167.308-.872 4.908Zm7.99 0h-4.191v-5.03h4.19v5.03Zm0-8.976h-4.191v-5.03h4.19v5.03Zm2.618 8.976 6.054-21.358h3.945l-6.054 21.358h-3.945Zm8.136 0 6.048-21.358h3.945l-6.054 21.358h-3.939Zm21.486.307c-1.863 0-2.887-1.085-3.072-2.792-.805 1.427-2.232 2.792-4.498 2.792-2.02 0-4.314-1.085-4.314-4.006 0-3.447 3.323-4.253 6.518-4.253.778 0 1.584.034 2.3.124v-.465c0-1.427-.034-3.133-2.3-3.133-.84 0-1.488.061-2.143.402l-.453 1.578-3.195-.34.549-3.224c2.45-.996 3.692-1.27 5.992-1.27 3.01 0 5.556 1.55 5.556 4.75v6.083c0 .805.314 1.085.963 1.085.184 0 .375-.034.587-.095l.034 2.11a5.432 5.432 0 0 1-2.524.654Z" fill="currentColor"></path></svg></a><ul class="footer-moz-list"><li class="footer-moz-item"><a href="https://www.mozilla.org/privacy/websites/" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Website Privacy Notice</a></li><li class="footer-moz-item"><a href="https://www.mozilla.org/privacy/websites/#cookies" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Cookies</a></li><li class="footer-moz-item"><a href="https://www.mozilla.org/about/legal/terms/mozilla" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Legal</a></li><li class="footer-moz-item"><a href="https://www.mozilla.org/about/governance/policies/participation/" class="footer-moz-link" target="_blank" rel="noopener noreferrer">Community Participation Guidelines</a></li></ul></div><div class="page-footer-legal"><p id="license" class="page-footer-legal-text">Visit <a href="https://www.mozilla.org" target="_blank" rel="noopener noreferrer">Mozilla Corporation’s</a> not-for-profit parent, the <a target="_blank" rel="noopener noreferrer" href="https://foundation.mozilla.org/">Mozilla Foundation</a>.<br/>Portions of this content are ©1998–2024 by individual mozilla.org contributors. Content available under <a href="/en-US/docs/MDN/Writing_guidelines/Attrib_copyright_license">a Creative Commons license</a>.</p></div></div></footer></div><script type="application/json" id="hydration">{"url":"/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN","doc":{"isMarkdown":true,"isTranslated":false,"isActive":true,"flaws":{},"title":"How to write in Markdown","mdn_url":"/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN","locale":"en-US","native":"English (US)","sidebarHTML":"<ol><li><a href=\"/en-US/docs/MDN\">The MDN Web Docs project</a></li><li class=\"toggle\"><details><summary>Community guidelines</summary><ol><li><a href=\"/en-US/docs/MDN/Community\">Community guidelines</a></li><li class=\"toggle\"><details><summary>Contributing to MDN Web Docs</summary><ol><li><a href=\"/en-US/docs/MDN/Community/Contributing\">Contributing to MDN Web Docs</a></li><li><a href=\"/en-US/docs/MDN/Community/Contributing/Getting_started\">Getting started with MDN Web Docs</a></li><li><a href=\"/en-US/docs/MDN/Community/Contributing/Our_repositories\">MDN Web Docs Repositories</a></li><li><a href=\"/en-US/docs/MDN/Community/Contributing/Translated_content\">MDN Web Docs Localization</a></li><li><a href=\"/en-US/docs/MDN/Community/Contributing/Security_vulnerability_response\">Security vulnerability response steps</a></li></ol></details></li><li><a href=\"/en-US/docs/MDN/Community/Open_source_etiquette\">Open source etiquette</a></li><li><a href=\"/en-US/docs/MDN/Community/Communication_channels\">Communication channels</a></li><li><a href=\"/en-US/docs/MDN/Community/Discussions\">Community discussions</a></li><li><a href=\"/en-US/docs/MDN/Community/Learn_forum\">Learn forum</a></li><li><a href=\"/en-US/docs/MDN/Community/Issues\">Guidelines to open and work on issues</a></li><li><a href=\"/en-US/docs/MDN/Community/Pull_requests\">Pull request submission and review guidelines</a></li><li><a href=\"/en-US/docs/MDN/Community/Roles_teams\">MDN Web Docs roles and teams</a></li></ol></details></li><li class=\"toggle\"><details open=\"\"><summary>Writing guidelines</summary><ol><li><a href=\"/en-US/docs/MDN/Writing_guidelines\">Writing guidelines</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/What_we_write\">What we write</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Writing_style_guide\">Writing style guide</a></li><li class=\"toggle\"><details open=\"\"><summary>How-to guides</summary><ol><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto\">How-to guides</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Images_media\">How to add images and media</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting\">How to create, move, delete, and edit pages</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Document_a_CSS_property\">How to document a CSS property</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Document_an_HTTP_header\">How to document an HTTP header</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Document_web_errors\">How to document web errors</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Research_technology\">How to research a technology</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data\">How to use structured data</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference\">How to write an API reference</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary\">How to write an entry in the glossary</a></li><li><em><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN\" aria-current=\"page\">How to write in Markdown</a></em></li></ol></details></li><li class=\"toggle\"><details><summary>Page structures</summary><ol><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures\">Page structures</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Banners_and_notices\">Banners and notices</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Code_examples\">Code examples</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables\">Compatibility tables and the browser compatibility data repository (BCD)</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Live_samples\">Live examples</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types\">Page types</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Sidebars\">Sidebars</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Specification_tables\">Specification tables</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Syntax_sections\">Syntax sections</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros\">Using macros</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Feature_status\">Feature status</a></li></ol></details></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Attrib_copyright_license\">Attribution and copyright licensing</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete\">Experimental, deprecated, and obsolete</a></li></ol></details></li><li class=\"toggle\"><details><summary>Advisory Board</summary><ol><li><a href=\"/en-US/docs/MDN/MDN_Product_Advisory_Board\">MDN Product Advisory Board</a></li><li><a href=\"/en-US/docs/MDN/MDN_Product_Advisory_Board/Membership\">Product Advisory Board Charter & Membership</a></li></ol></details></li><li class=\"toggle\"><details><summary>History</summary><ol><li><a href=\"/en-US/docs/MDN/At_ten\">MDN at 10</a></li><li><a href=\"/en-US/docs/MDN/At_ten/History_of_MDN\">The history of MDN</a></li></ol></details></li><li><a href=\"/en-US/docs/MDN/Changelog\">MDN Web Docs changelog</a></li></ol>","sidebarMacro":"MDNSidebar","body":[{"type":"prose","value":{"id":null,"title":null,"isH3":false,"content":"<p>This page describes how we use Markdown to write documentation on MDN Web Docs. We have chosen GitHub-Flavored Markdown (GFM) as a baseline, and added some extensions to support some of the things we need to do on MDN that aren't readily supported in GFM.</p>"}},{"type":"prose","value":{"id":"baseline_github-flavored_markdown","title":"Baseline: GitHub-Flavored Markdown","isH3":false,"content":"<p>The baseline for MDN Markdown is GitHub-Flavored Markdown (GFM): <a href=\"https://github.github.com/gfm/\" class=\"external\" target=\"_blank\">https://github.github.com/gfm/</a>. This means that you can refer to the GFM specification for anything not explicitly specified in this page. GFM in turn is a superset of CommonMark (<a href=\"https://spec.commonmark.org/\" class=\"external\" target=\"_blank\">https://spec.commonmark.org/</a>).</p>"}},{"type":"prose","value":{"id":"links","title":"Links","isH3":false,"content":"<p>The GFM specification defines two basic types of links:</p>\n<ul>\n <li><a href=\"https://github.github.com/gfm/#inline-link\" class=\"external\" target=\"_blank\">inline links</a>, in which the destination is given immediately after the link text.</li>\n <li><a href=\"https://github.github.com/gfm/#reference-link\" class=\"external\" target=\"_blank\">reference links</a>, in which the destination is defined elsewhere in the document.</li>\n</ul>\n<p>On MDN we allow only inline links.</p>\n<p>This is the correct way to write GFM links on MDN:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md example-good notranslate\"><code>[Macarons](https://en.wikipedia.org/wiki/Macaron) are delicious but tricky to make.\n</code></pre></div>\n<p>This is an incorrect way to write links on MDN:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md example-bad notranslate\"><code>[Macarons][macaron] are delicious but tricky to make.\n\n[macaron]: https://en.wikipedia.org/wiki/Macaron\n</code></pre></div>"}},{"type":"prose","value":{"id":"example_code_blocks","title":"Example code blocks","isH3":false,"content":"<p>In GFM and CommonMark, authors can use \"code fences\" to demarcate <code><pre></code> blocks. The opening code fence may be followed by some text that is called the \"info string\". The specification states the following:</p>\n<blockquote>\n <p>The first word of the info string is typically used to specify the language of the code sample, and rendered in the class attribute of the code tag.</p>\n</blockquote>\n<p>It's permissible for the info string to contain multiple words, like:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>```fee fi fo fum\n// some example code\n```\n</code></pre></div>\n<p>On MDN, writers will use code fences for example code blocks. They must specify the language of the code sample using the first word of the info string, and this will be used to provide syntax highlighting for the block. The following words are supported:</p>\n<ul>\n <li>Programming Languages\n <ul>\n <li>JavaScript\n <ul>\n <li><code>js</code> - JavaScript</li>\n <li><code>ts</code> - TypeScript</li>\n <li><code>jsx</code> - React JSX</li>\n <li><code>tsx</code> - React TSX</li>\n </ul>\n </li>\n <li>C-like\n <ul>\n <li><code>c</code> - C</li>\n <li><code>cpp</code> - C++</li>\n <li><code>cs</code> - C#</li>\n <li><code>java</code> - Java</li>\n </ul>\n </li>\n <li>Other\n <ul>\n <li><code>python</code> - Python</li>\n <li><code>php</code> - PHP</li>\n <li><code>rust</code> - Rust</li>\n <li><code>glsl</code> - GLSL (OpenGL Shaders)</li>\n <li><code>sql</code> - SeQueL commands</li>\n <li><code>wasm</code> - WebAssembly</li>\n <li><code>webidl</code> - Web Interface Definition Language</li>\n </ul>\n </li>\n </ul>\n </li>\n <li>Styling\n <ul>\n <li><code>css</code> - CSS</li>\n <li><code>scss</code> - Sass (SCSS)</li>\n <li><code>less</code> - Less</li>\n </ul>\n </li>\n <li>Markup\n <ul>\n <li><code>html</code> - HTML</li>\n <li><code>svg</code> - SVG</li>\n <li><code>xml</code> - XML</li>\n <li><code>mathml</code> - MathML</li>\n <li><code>md</code> - Markdown</li>\n <li><code>latex</code> - LaTeX</li>\n </ul>\n </li>\n <li>Command Prompts\n <ul>\n <li><code>bash</code> - Bash/Shell</li>\n <li><code>batch</code> - Batch (Windows Shell)</li>\n <li><code>powershell</code> - PowerShell</li>\n </ul>\n </li>\n <li>Configuration/Data Files\n <ul>\n <li><code>json</code> - JSON</li>\n <li><code>ini</code> - INI</li>\n <li><code>yaml</code> - YAML</li>\n <li><code>toml</code> - TOML</li>\n <li><code>sql</code> - SQL Database</li>\n <li><code>ignore</code> - Gitignore file</li>\n <li><code>apacheconf</code> - Apache configuration</li>\n <li><code>nginx</code> - NGINX configuration</li>\n </ul>\n </li>\n <li>Templates\n <ul>\n <li><code>django</code> - Django templates</li>\n <li><code>svelte</code> - Svelte templates</li>\n <li><code>handlebars</code> - Handlebars templates</li>\n <li><code>pug</code> - <a href=\"https://pugjs.org/api/getting-started.html\" class=\"external\" target=\"_blank\">Pug templates</a> (which may be used by <a href=\"/en-US/docs/Learn/Server-side/Express_Nodejs/Displaying_data/Template_primer\">Express</a>)</li>\n </ul>\n </li>\n <li>Other\n <ul>\n <li><code>plain</code> - Plain text</li>\n <li><code>diff</code> - Diff file</li>\n <li><code>http</code> - HTTP headers</li>\n <li><code>regex</code> - Regex</li>\n <li><code>uri</code> - URIs and URLs</li>\n </ul>\n </li>\n</ul>\n<p>For example:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>```js\nconst greeting = \"I will get JavaScript syntax highlighting\";\n```\n</code></pre></div>\n<p>\n If the highlighting that you wish to use is not listed above, you should markup the code block as <code>plain</code>.\n Additional languages may be requested in the process <a href=\"https://github.com/orgs/mdn/discussions/170#discussioncomment-3404366\" class=\"external\" target=\"_blank\">discussed on GitHub</a>.\n</p>"}},{"type":"prose","value":{"id":"suppressing_linting","title":"Suppressing linting","isH3":true,"content":"<p>Writers can add a <code>-nolint</code> suffix to any of the language identifiers:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>```html-nolint\n<p>\nI will not be linted.\n</p>\n```\n</code></pre></div>\n<p>Code blocks like this will get appropriate syntax highlighting and will be recognized by the live sample system, but will be ignored by linters or automatic formatters like Prettier. Authors should use this suffix for showing invalid code or alternative formatting that linters or formatters should not fix.</p>"}},{"type":"prose","value":{"id":"additional_classes_info_strings","title":"Additional classes (info strings)","isH3":true,"content":"<p>GFM supports <a href=\"https://github.github.com/gfm/#info-string\" class=\"external\" target=\"_blank\">info strings</a>, which allow authors to supply additional information about a code block. On MDN, info strings are converted into class names.</p>\n<p>Writers will be able to supply any one of the following info strings:</p>\n<ul>\n <li><code>example-good</code>: style this example as a good example (one to follow)</li>\n <li><code>example-bad</code>: style this example as a bad example (one to avoid)</li>\n <li><code>hidden</code>: don't render this code block in the page. This is for use in live samples.</li>\n</ul>\n<p>For example:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>```js example-good\nconst greeting = \"I'm a good example\";\n```\n\n```js example-bad\nconst greeting = \"I'm a bad example\";\n```\n\n```js hidden\nconst greeting = \"I'm a secret greeting\";\n```\n</code></pre></div>\n<p>These will be rendered as:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js example-good notranslate\"><code>const greeting = \"I'm a good example\";\n</code></pre></div>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js example-bad notranslate\"><code>const greeting = \"I'm a bad example\";\n</code></pre></div>"}},{"type":"prose","value":{"id":"discussion_reference","title":"Discussion reference","isH3":true,"content":"<p>This issue was resolved in:</p>\n<ul>\n <li><a href=\"https://github.com/mdn/content/issues/3512\" class=\"external\" target=\"_blank\">https://github.com/mdn/content/issues/3512</a></li>\n <li><a href=\"https://github.com/mdn/yari/pull/7017\" class=\"external\" target=\"_blank\">https://github.com/mdn/yari/pull/7017</a></li>\n</ul>"}},{"type":"prose","value":{"id":"notes_warnings_and_callouts","title":"Notes, warnings, and callouts","isH3":false,"content":"<p>Writers can use the <a href=\"https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts\" class=\"external\" target=\"_blank\">GFM alerts syntax</a> to call special attention to content. There are three types of alerts: notes, warnings, and callouts.</p>\n<div class=\"notecard note\">\n <p>\n <strong>Note:</strong> MDN Web Docs supported alerts with its own syntax prior to support for GFM alerts, and referred to them as \"noteblocks\".\n MDN does not support the following GFM alerts: <code>[!TIP]</code>, <code>[!CAUTION]</code>, <code>[!IMPORTANT]</code>.\n GFM does not support <code>[!CALLOUT]</code>.\n </p>\n</div>\n<ul>\n <li>To add a note, create a blockquote whose first line is <code>[!NOTE]</code>.</li>\n <li>To add a warning, create a blockquote whose first line is <code>[!WARNING]</code>.</li>\n <li>To add a callout, create a blockquote whose first line is <code>[!CALLOUT]</code>.</li>\n</ul>\n<p>Notes and warnings will add a localized <strong>Note:</strong> or <strong>Warning:</strong> to the beginning of the output, while callouts will not. This makes callouts a good choice when an author wants to provide a custom title.</p>\n<div class=\"notecard warning\">\n <p><strong>Warning:</strong> In the older MDN syntax, the type was localized and added to the first paragraph in bold text, i.e. <code>**Note:** Foo bar</code> instead of <code>[!NOTE] ⏎ Foo bar</code>.</p>\n <p>The older syntax is still supported for migration purposes. Avoid using it in new documentation.</p>\n</div>\n<div class=\"notecard warning\">\n <p><strong>Warning:</strong> Currently, due to a <a href=\"https://github.com/prettier/prettier/issues/15479\" class=\"external\" target=\"_blank\">Prettier bug</a>, the GFM alert syntax cannot be used if the first character of a note or warning is a formatting symbol, such as a backquote, asterisk, square bracket or curly bracket. In this case, use the old syntax <code>> **Note:**</code> instead. Writers are not required to rephrase the content to work around the formatter.</p>\n</div>\n<p>Multiple lines are produced by an empty block quote line in the same way as normal paragraphs. Further, multiple lines without a space are also treated like normal Markdown lines, and concatenated.</p>\n<p>The blockquote can contain code blocks or other block elements.</p>"}},{"type":"prose","value":{"id":"examples","title":"Examples","isH3":true,"content":"<h4 id=\"note\">Note</h4>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>> [!NOTE]\n> This is how you write a note.\n>\n> It can have multiple lines.\n</code></pre></div>\n<p>This will produce the following HTML:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">html</span></div><pre class=\"brush: html notranslate\"><code><div class=\"notecard note\">\n <p><strong>Note:</strong> This is how you write a note.</p>\n <p>It can have multiple lines.</p>\n</div>\n</code></pre></div>\n<p>This HTML will be rendered as a highlighted box:</p>\n<div class=\"notecard note\">\n <p><strong>Note:</strong> This is how you write a note.</p>\n <p>It can have multiple lines.</p>\n</div>\n<h4 id=\"warnings\">Warnings</h4>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>> [!WARNING]\n> This is how you write a warning.\n>\n> It can have multiple paragraphs.\n</code></pre></div>\n<p>This will produce the following HTML:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">html</span></div><pre class=\"brush: html notranslate\"><code><div class=\"notecard warning\">\n <p><strong>Warning:</strong> This is how you write a warning.</p>\n <p>It can have multiple paragraphs.</p>\n</div>\n</code></pre></div>\n<p>This HTML will be rendered as a highlighted box:</p>\n<div class=\"notecard warning\">\n <p><strong>Warning:</strong> This is how you write a warning.</p>\n <p>It can have multiple paragraphs.</p>\n</div>\n<h4 id=\"callouts\">Callouts</h4>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>> [!CALLOUT]\n>\n> **This is how you write a callout.**\n>\n> It can have multiple paragraphs.\n</code></pre></div>\n<p>This will produce the following HTML:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">html</span></div><pre class=\"brush: html notranslate\"><code><div class=\"callout\">\n <p><strong>This is how you write a callout.</strong></p>\n <p>It can have multiple paragraphs.</p>\n</div>\n</code></pre></div>\n<p>This HTML will be rendered as a highlighted box:</p>\n<div class=\"callout\">\n <p><strong>This is how you write a callout.</strong></p>\n <p>It can have multiple paragraphs.</p>\n</div>\n<h4 id=\"note_containing_a_code_block\">Note containing a code block</h4>\n<p>This example contains a code block.</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>> [!NOTE]\n> This is how you write a note.\n>\n> It can contain code blocks.\n>\n> ```js\n> const s = \"I'm in a code block\";\n> ```\n>\n> Like that.\n</code></pre></div>\n<p>This will produce the following HTML:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">html</span></div><pre class=\"brush: html notranslate\"><code><div class=\"notecard note\">\n <p><strong>Note:</strong> This is how you write a note.</p>\n <p>It can contain code blocks.</p>\n <pre class=\"brush: js\">const s = \"I'm in a code block\";</pre>\n <p>Like that.</p>\n</div>\n</code></pre></div>\n<p>This HTML will be rendered as with a code block:</p>\n<div class=\"notecard note\">\n <p><strong>Note:</strong> This is how you write a note.</p>\n <p>It can contain code blocks.</p>\n <div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">js</span></div><pre class=\"brush: js notranslate\"><code>const s = \"I'm in a code block\";\n</code></pre></div>\n <p>Like that.</p>\n</div>"}},{"type":"prose","value":{"id":"discussion_reference_2","title":"Discussion reference","isH3":true,"content":"<p>This issue was resolved in <a href=\"https://github.com/mdn/content/issues/3483\" class=\"external\" target=\"_blank\">https://github.com/mdn/content/issues/3483</a>.</p>"}},{"type":"prose","value":{"id":"definition_lists","title":"Definition lists","isH3":false,"content":"<p>Definition lists are commonly used across MDN, but are not supported by GFM. MDN introduces a custom format for definition lists, which is a modified form of a GFM unordered list (<a href=\"/en-US/docs/Web/HTML/Element/ul\"><code><ul></code></a>). In this format:</p>\n<ul>\n <li>The GFM <code><ul></code> contains any number of top-level GFM <code><li></code> elements.</li>\n <li>Each of these top-level GFM <code><li></code> elements must contain, as its final element, one GFM <code><ul></code> element.</li>\n <li>This final nested <code><ul></code> must contain a single GFM <code><li></code> element, whose text content must start with \": \" (a colon followed by a space). This element may contain block elements, including paragraphs, code blocks, embedded lists, and notes.</li>\n</ul>\n<p>Each of these top-level GFM <code><li></code> elements will be transformed into a <code><dt></code>/<code><dd></code> pair, as follows:</p>\n<ul>\n <li>The top-level GFM <code><li></code> element will be parsed as a GFM <code><li></code> element and its internal contents will comprise the contents of the <code><dt></code>, except for the final nested <code><ul></code>, which will not be included in the <code><dt></code>.</li>\n <li>The <code><li></code> element in the final nested <code><ul></code> will be parsed as a GFM <code><li></code> element and its internal contents will comprise the contents of the <code><dd></code>, except for the leading \": \", which will be discarded.</li>\n</ul>\n<p>For example, this is a <code><dl></code>:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>- term1\n\n - : My description of term1\n\n- `term2`\n\n - : My description of term2\n\n It can have multiple paragraphs, and code blocks too:\n\n ```js\n const thing = 1;\n ```\n</code></pre></div>\n<p>In GFM/CommonMark, this would produce the following HTML:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">html</span></div><pre class=\"brush: html notranslate\"><code><ul>\n <li>\n <p>term1</p>\n <ul>\n <li>: My description of term1</li>\n </ul>\n </li>\n <li>\n <p><code>term2</code></p>\n <ul>\n <li>\n <p>: My description of term2</p>\n <p>It can have multiple paragraphs, and code blocks too:</p>\n <pre>\n <code class=\"brush: js\">const thing = 1;</code>\n </pre>\n </li>\n </ul>\n </li>\n</ul>\n</code></pre></div>\n<p>On MDN, this would produce the following HTML:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">html</span></div><pre class=\"brush: html notranslate\"><code><dl>\n <dt>\n <p>term1</p>\n </dt>\n <dd>My description of term1</dd>\n <dt>\n <p><code>term2</code></p>\n </dt>\n <dd>\n <p>My description of term2</p>\n <p>It can have multiple paragraphs, and code blocks too:</p>\n <pre>\n <code class=\"brush: js\">const thing = 1;</code>\n </pre>\n </dd>\n</dl>\n</code></pre></div>\n<p>Definition lists written using this syntax must consist of pairs of <code><dt></code>/<code><dd></code> elements. Using this syntax, it's not possible to write a list with more than one consecutive <code><dt></code> element or more than one consecutive <code><dd></code> element: the parser will treat this as an error. We expect almost all definition lists on MDN will work with this limitation, and for those that do not, authors can fall back to raw HTML.</p>\n<p>This is not permitted:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md example-bad notranslate\"><code>- `param1`, `param2`, `param3`\n - : My description of `param1`\n - : My description of `param2`\n - : My description of `param3`\n</code></pre></div>\n<p>As a workaround for cases where an author needs to associate multiple <code><dt></code> items with a single <code><dd></code>, consider providing them as a single <code><dt></code> that holds multiple terms, separated by commas, like this:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md example-good notranslate\"><code>- `param1`, `param2`, `param3`\n - : My description of params 1, 2, and 3\n</code></pre></div>\n<p>The rationale for the syntax described here is that it works well enough with tools that expect CommonMark (for example, Prettier or GitHub previews) while being reasonably easy to write and to parse.</p>"}},{"type":"prose","value":{"id":"discussion_reference_3","title":"Discussion reference","isH3":true,"content":"<p>This issue was resolved in <a href=\"https://github.com/mdn/content/issues/4367\" class=\"external\" target=\"_blank\">https://github.com/mdn/content/issues/4367</a>.</p>"}},{"type":"prose","value":{"id":"tables","title":"Tables","isH3":false,"content":"<p>GFM provides a syntax for creating <a href=\"https://github.github.com/gfm/#tables-extension-\" class=\"external\" target=\"_blank\">tables</a>, which we make use of in MDN. However, there are times when GFM tables do not suit our needs:</p>\n<ul>\n <li>The GFM syntax only supports a subset of the features available in HTML. If you need to use table features that are not supported in GFM, use HTML for the table.</li>\n <li>If the GFM representation of the table would be more than 150 characters wide, use HTML for the table.</li>\n <li>We support a special kind of table called a \"properties table\", which has its own CSS class and is therefore always HTML.</li>\n</ul>\n<p>So the general principle is that authors should use the GFM Markdown syntax when they can, and fall back to raw HTML when they have to or when HTML is more readable. For more information, see <a href=\"#when_to_use_html_tables\">When to use HTML tables</a>.</p>"}},{"type":"prose","value":{"id":"gfm_table_syntax_style","title":"GFM table syntax style","isH3":true,"content":"<p>In GFM table syntax, authors can omit leading and trailing pipes for rows. However, for the sake of readability, MDN authors must include these pipes. Additionally, authors must provide trailing spaces in rows, so that all cells in a column are the same length in plain text.</p>\n<p>That is, MDN authors must use this style:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md example-good notranslate\"><code>| Heading 1 | Heading 2 | Heading 3 |\n| --------- | --------- | --------- |\n| cell 1 | cell 2 | cell 3 |\n| cell 4 | cell 5 | cell 6 |\n</code></pre></div>\n<p>and not this style:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md example-bad notranslate\"><code>| Heading 1 | Heading 2 | Heading 3 |\n| --------- | --- |----------------------|\n| cell 1 | cell 2 | cell 3 |\ncell 4 | cell 5 | cell 6\n</code></pre></div>\n<p>Luckily, table formatting is auto-fixed by Prettier, so authors may rely on Prettier to format their tables properly.</p>"}},{"type":"prose","value":{"id":"when_to_use_html_tables","title":"When to use HTML tables","isH3":true,"content":"<p>There are three main circumstances in which authors should use HTML tables rather than GFM syntax:</p>\n<ol>\n <li>The table uses features that are not supported in GFM (see below).</li>\n <li>The GFM table would be too wide to be readable.</li>\n <li>The writer wants a special type of table called a \"properties table\".</li>\n</ol>\n<h4 id=\"table_features_that_are_not_supported_in_gfm\">Table features that are not supported in GFM</h4>\n<p>The main limitations of GFM table syntax are:</p>\n<ul>\n <li>GFM tables must have a header row.</li>\n <li>GFM tables may not have a header column.</li>\n <li>GFM won't parse GFM block elements in table cells. For example, you can't have a list in a table cell.</li>\n <li>GFM tables cannot have classes assigned to them.</li>\n <li>GFM doesn't support any table elements beyond <code><table></code>, <code><tr></code>, <code><th></code>, and <code><td></code>.</li>\n <li>GFM doesn't support any table element attributes like <code>colspan</code>, <code>rowspan</code>, or <code>scope</code>.</li>\n</ul>\n<p>If an author needs to use any of the unsupported features, they should write the table in HTML.</p>\n<p>Note that we don't recommend the general use of <code><caption></code> elements on tables, since that would also rule out the GFM syntax.</p>\n<h4 id=\"gfm_table_maximum_width\">GFM table maximum width</h4>\n<p>Even when a table could be written in GFM it is sometimes better to use HTML, because GFM uses an \"<a href=\"/en-US/docs/Glossary/ASCII\">ASCII</a> art\" approach to tables that is not readable when table rows get long. Consider the following table:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">html</span></div><pre class=\"brush: html notranslate\"><code><table>\n <tr>\n <th>A heading 1</th>\n <th>A heading 2</th>\n <th>A heading 3</th>\n <th>A heading 4</th>\n <th>A heading 5</th>\n <th>A heading 6</th>\n </tr>\n <tr>\n <td>Something shortish</td>\n <td>\n Something much longer that really goes into a lot of detail about\n something, so much so that the table formatting starts to look bad in GFM\n format.\n </td>\n <td>Something shortish</td>\n <td>\n Another cell with lots of text in it, that also really goes into a lot of\n detail about something, so much so that the table formatting starts to\n look bad in GFM format.\n </td>\n <td>Something shortish</td>\n <td>Something shortish</td>\n </tr>\n</table>\n</code></pre></div>\n<p>In GFM this will look like:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>| A heading 1 | A heading 2 | A heading 3 | A heading 4 | A heading 5 | A heading 6 |\n| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | ------------------ |\n| Something shortish | Something much longer that really goes into a lot of detail about something, so much so that the table formatting starts to look bad in GFM format. | Something shortish | Another cell with lots of text in it, that also really goes into a lot of detail about something, so much so that the table formatting starts to look bad in GFM format. | Something shortish | Something shortish |\n</code></pre></div>\n<p>In a case like this it would be better to use HTML.</p>\n<p>This leads us to the following guideline: <em>if the Markdown representation of the table would be more than 150 characters wide, use HTML for the table</em>.</p>\n<h4 id=\"properties_tables\">Properties tables</h4>\n<p>Properties tables are a specific type of table used for displaying structured property-value content across a set of pages of a particular type. These tables have two columns: the first column is the header column and lists the properties, and the second column lists their values for this particular item. For example, here's the properties table for the <a href=\"/en-US/docs/Web/API/PannerNode\"><code>PannerNode</code></a> interface:</p>\n<figure class=\"table-container\"><table class=\"properties\">\n <tbody>\n <tr>\n <th scope=\"row\">Number of inputs</th>\n <td><code>1</code></td>\n </tr>\n <tr>\n <th scope=\"row\">Number of outputs</th>\n <td><code>0</code></td>\n </tr>\n <tr>\n <th scope=\"row\">Channel count mode</th>\n <td><code>\"explicit\"</code></td>\n </tr>\n <tr>\n <th scope=\"row\">Channel count</th>\n <td><code>2</code></td>\n </tr>\n <tr>\n <th scope=\"row\">Channel interpretation</th>\n <td><code>\"speakers\"</code></td>\n </tr>\n </tbody>\n</table></figure>\n<p>\n These pages can't be represented in GFM because they have a header column, so writers should use HTML in this case.\n To get the special styling, writers should apply the <code>\"properties\"</code> class to the table:\n</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">html</span></div><pre class=\"brush: html notranslate\"><code><table class=\"properties\"></table>\n</code></pre></div>"}},{"type":"prose","value":{"id":"discussion_reference_4","title":"Discussion reference","isH3":true,"content":"<p>This issue was resolved in <a href=\"https://github.com/mdn/content/issues/4325\" class=\"external\" target=\"_blank\">https://github.com/mdn/content/issues/4325</a>, <a href=\"https://github.com/mdn/content/issues/7342\" class=\"external\" target=\"_blank\">https://github.com/mdn/content/issues/7342</a>, and <a href=\"https://github.com/mdn/content/issues/7898#issuecomment-913265900\" class=\"external\" target=\"_blank\">https://github.com/mdn/content/issues/7898#issuecomment-913265900</a>.</p>"}},{"type":"prose","value":{"id":"superscript_and_subscript","title":"Superscript and subscript","isH3":false,"content":"<p>Writers will be able to use the HTML <a href=\"/en-US/docs/Web/HTML/Element/sup\"><code><sup></code></a> and <a href=\"/en-US/docs/Web/HTML/Element/sub\"><code><sub></code></a> elements if necessary, but should use alternatives if possible. In particular:</p>\n<ul>\n <li>For exponentiation, use the caret: <code>2^53</code>.</li>\n <li>For ordinal expressions like 1<sup>st</sup>, prefer words like \"first\".</li>\n <li>For footnotes, don't mark up the footnote references, e.g., <code><sup>[1]</sup></code>.</li>\n</ul>"}},{"type":"prose","value":{"id":"discussion_reference_5","title":"Discussion reference","isH3":true,"content":"<p>This issue was resolved in <a href=\"https://github.com/mdn/content/issues/4578\" class=\"external\" target=\"_blank\">https://github.com/mdn/content/issues/4578</a>.</p>"}},{"type":"prose","value":{"id":"page_summary","title":"Page summary","isH3":false,"content":"<p>The <em>page summary</em> is the first \"content\" paragraph in a page—the first text that appears after the page front matter and any <a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros/Commonly_used_macros#sidebar_generation\">sidebar</a> or <a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros/Commonly_used_macros#page_or_section_header_indicators\">page banner</a> macros.</p>\n<p>\n This summary is used for search engine optimization (SEO) and also automatically included alongside page listings by some macros.\n The first paragraph should therefore be both succinct and informative.\n</p>"}},{"type":"prose","value":{"id":"discussion_reference_6","title":"Discussion reference","isH3":true,"content":"<p>This issue was resolved in <a href=\"https://github.com/mdn/content/issues/3923\" class=\"external\" target=\"_blank\">https://github.com/mdn/content/issues/3923</a>.</p>"}},{"type":"prose","value":{"id":"kumascript","title":"KumaScript","isH3":false,"content":"<p>Writers will be able to include KumaScript macro calls in prose content:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>The **`margin`** [CSS](/en-US/docs/Web/CSS) property\nsets the margin area on all four sides of an element. It is a shorthand for\n{{cssxref(\"margin-top\")}}, {{cssxref(\"margin-right\")}}, {{cssxref(\"margin-bottom\")}},\nand {{cssxref(\"margin-left\")}}.\n\n{{EmbedInteractiveExample(\"pages/css/margin.html\")}}\n\nThe top and bottom margins have no effect on replaced inline elements, such as\n{{HTMLElement(\"span\")}} or {{HTMLElement(\"code\")}}.\n</code></pre></div>\n<p>See <a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros\">Using macros</a> for more information on macros.</p>"}}],"toc":[{"text":"Baseline: GitHub-Flavored Markdown","id":"baseline_github-flavored_markdown"},{"text":"Links","id":"links"},{"text":"Example code blocks","id":"example_code_blocks"},{"text":"Notes, warnings, and callouts","id":"notes_warnings_and_callouts"},{"text":"Definition lists","id":"definition_lists"},{"text":"Tables","id":"tables"},{"text":"Superscript and subscript","id":"superscript_and_subscript"},{"text":"Page summary","id":"page_summary"},{"text":"KumaScript","id":"kumascript"}],"summary":"This page describes how we use Markdown to write documentation on MDN Web Docs. We have chosen GitHub-Flavored Markdown (GFM) as a baseline, and added some extensions to support some of the things we need to do on MDN that aren't readily supported in GFM.","popularity":0.0059,"modified":"2024-08-09T02:13:21.000Z","other_translations":[{"locale":"de","title":"Anleitung zur Verwendung von Markdown","native":"Deutsch"},{"locale":"es","title":"Cómo escribir en Markdown","native":"Español"},{"locale":"fr","title":"Comment écrire du Markdown","native":"Français"},{"locale":"ja","title":"Markdown の書き方","native":"日本語"},{"locale":"pt-BR","title":"Como escrever em Markdown","native":"Português (do Brasil)"},{"locale":"zh-CN","title":"如何使用 Markdown 来撰写文档","native":"中文 (简体)"}],"pageType":"mdn-writing-guide","source":{"folder":"en-us/mdn/writing_guidelines/howto/markdown_in_mdn","github_url":"https://github.com/mdn/content/blob/main/files/en-us/mdn/writing_guidelines/howto/markdown_in_mdn/index.md","last_commit_url":"https://github.com/mdn/content/commit/487085d8bbd6d80719e6c28ade98563479727df7","filename":"index.md"},"short_title":"How to write in Markdown","parents":[{"uri":"/en-US/docs/MDN","title":"The MDN Web Docs project"},{"uri":"/en-US/docs/MDN/Writing_guidelines","title":"Writing guidelines"},{"uri":"/en-US/docs/MDN/Writing_guidelines/Howto","title":"How-to guides"},{"uri":"/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN","title":"How to write in Markdown"}],"pageTitle":"How to write in Markdown - The MDN Web Docs project | MDN","noIndexing":false}}</script></body></html>