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>Markdown の書き方 - MDN Web Docs プロジェクト | 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="How to write in Markdown" href="https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" hrefLang="en"/><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="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="Markdown の書き方" href="https://developer.mozilla.org/ja/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" hrefLang="ja"/><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="このページでは、 Markdown を使用してどのように MDN Web Docs のドキュメントを書くかを説明します。ベースラインとして GitHub-Flavored Markdown (GFM) を選択し、 GFM では容易にサポートされていない MDN で行う必要のあるいくつかのことに対応するために、いくつかの拡張機能を追加しました。"/><meta property="og:url" content="https://developer.mozilla.org/ja/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN"/><meta property="og:title" content="Markdown の書き方 - MDN Web Docs プロジェクト | MDN"/><meta property="og:type" content="website"/><meta property="og:locale" content="ja"/><meta property="og:description" content="このページでは、 Markdown を使用してどのように MDN Web Docs のドキュメントを書くかを説明します。ベースラインとして GitHub-Flavored Markdown (GFM) を選択し、 GFM では容易にサポートされていない MDN で行う必要のあるいくつかのことに対応するために、いくつかの拡張機能を追加しました。"/><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/ja/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="/ja/" 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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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="/ja/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=%2Fja%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=%2Fja%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="/ja/docs/MDN" class="breadcrumb" property="item" typeof="WebPage"><span property="name">MDN Web Docs プロジェクト</span></a><meta property="position" content="1"/></li><li property="itemListElement" typeof="ListItem"><a href="/ja/docs/MDN/Writing_guidelines" class="breadcrumb" property="item" typeof="WebPage"><span property="name">執筆ガイドライン</span></a><meta property="position" content="2"/></li><li property="itemListElement" typeof="ListItem"><a href="/ja/docs/MDN/Writing_guidelines/Howto" class="breadcrumb" property="item" typeof="WebPage"><span property="name">How-to ガイド</span></a><meta property="position" content="3"/></li><li property="itemListElement" typeof="ListItem"><a href="/ja/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" class="breadcrumb-current-page" property="item" typeof="WebPage"><span property="name">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>日本語</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="en-US" href="/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" class="button submenu-item"><span>English (US)</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="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="container"><div class="notecard localized-content-note"><p><a href="/ja/docs/MDN/Community/Contributing/Translated_content#アクティブなロケール">このページはコミュニティーの尽力で英語から翻訳されました。MDN Web Docs コミュニティーについてもっと知り、仲間になるにはこちらから。</a></p></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">この記事では</h2></header><ul class="document-toc-list"><li class="document-toc-item "><a class="document-toc-link" href="#ベースライン_github-flavored_markdown">ベースライン: GitHub-Flavored Markdown</a></li><li class="document-toc-item "><a class="document-toc-link" href="#リンク">リンク</a></li><li class="document-toc-item "><a class="document-toc-link" href="#コードブロックの例">コードブロックの例</a></li><li class="document-toc-item "><a class="document-toc-link" href="#メモ、警告、コールアウト">メモ、警告、コールアウト</a></li><li class="document-toc-item "><a class="document-toc-link" href="#定義リスト">定義リスト</a></li><li class="document-toc-item "><a class="document-toc-link" href="#表">表</a></li><li class="document-toc-item "><a class="document-toc-link" href="#上付き・下付き文字">上付き・下付き文字</a></li><li class="document-toc-item "><a class="document-toc-link" href="#ページ概要">ページ概要</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="/ja/docs/MDN">MDN Web Docs プロジェクト</a></li><li class="toggle"><details><summary>Community guidelines</summary><ol><li><a href="/ja/docs/MDN/Community">コミュニティガイドライン</a></li><li class="toggle"><details><summary>Contributing to MDN Web Docs</summary><ol><li><a href="/ja/docs/MDN/Community/Contributing">MDN Web Docs への協力</a></li><li><a href="/ja/docs/MDN/Community/Contributing/Getting_started">MDN を始めよう</a></li><li><a href="/ja/docs/MDN/Community/Contributing/Our_repositories">MDN Web Docs のリポジトリー</a></li><li><a href="/ja/docs/MDN/Community/Contributing/Translated_content">MDN Web Docs のローカライズ</a></li><li><a href="/ja/docs/MDN/Community/Contributing/Security_vulnerability_response">セキュリティ脆弱性への対応策</a></li></ol></details></li><li><a href="/ja/docs/MDN/Community/Open_source_etiquette">オープンソースのエチケット</a></li><li><a href="/ja/docs/MDN/Community/Communication_channels">コミュニケーション手段</a></li><li><a href="/ja/docs/MDN/Community/Discussions">コミュニティのディスカッション</a></li><li><a href="/ja/docs/MDN/Community/Learn_forum">学習フォーラム</a></li><li><a href="/ja/docs/MDN/Community/Issues">課題の作成と作業のガイドライン</a></li><li><a href="/ja/docs/MDN/Community/Pull_requests">プルリクエストの提出とレビューのガイドライン</a></li><li><a href="/ja/docs/MDN/Community/Roles_teams">MDN Web Docs の役割とチーム</a></li></ol></details></li><li class="toggle"><details open=""><summary>Writing guidelines</summary><ol><li><a href="/ja/docs/MDN/Writing_guidelines">執筆ガイドライン</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/What_we_write">私たちが書くもの</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Writing_style_guide">執筆スタイルガイド</a></li><li class="toggle"><details open=""><summary>How-to guides</summary><ol><li><a href="/ja/docs/MDN/Writing_guidelines/Howto">How-to ガイド</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Images_media">画像やメディアの追加方法</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting">ページの作成、移動、削除、編集方法</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Document_a_CSS_property">CSS プロパティの記事の作成方法</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Document_an_HTTP_header">HTTP ヘッダーの記事の作成方法</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Document_web_errors">ウェブのエラー記事の作成方法</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Research_technology">技術の調査方法</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data">構造化データの使用方法</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference">API リファレンスの書き方</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary">用語集の項目を執筆する方法</a></li><li><em><a href="/ja/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN" aria-current="page">Markdown の書き方</a></em></li></ol></details></li><li class="toggle"><details><summary>Page structures</summary><ol><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures">文書の構造</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Banners_and_notices">バナーと注意</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Code_examples">コードサンプル</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables">互換性一覧表とブラウザー互換性データリポジトリー (BCD)</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Live_samples">ライブサンプル</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Page_types">ページの種類</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Sidebars">サイドバー</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Specification_tables">仕様書一覧表</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Syntax_sections">構文の節</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Macros">マクロの使用</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status">機能状態</a></li></ol></details></li><li><a href="/ja/docs/MDN/Writing_guidelines/Attrib_copyright_license">帰属表示と著作権使用許諾</a></li><li><a href="/ja/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete">実験的、非推奨、廃止</a></li></ol></details></li><li class="toggle"><details><summary>Advisory Board</summary><ol><li><a href="/ja/docs/MDN/MDN_Product_Advisory_Board">MDN 製品諮問委員会</a></li><li><a href="/ja/docs/MDN/MDN_Product_Advisory_Board/Membership">製品諮問委員会憲章および会員資格</a></li></ol></details></li><li class="toggle"><details><summary>History</summary><ol><li><a href="/ja/docs/MDN/At_ten">MDN は 10 周年を迎えました</a></li><li><a href="/ja/docs/MDN/At_ten/History_of_MDN">MDN のあゆみ</a></li></ol></details></li><li><a href="/ja/docs/MDN/Changelog">MDN Web Docs の変更履歴</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">この記事では</h2></header><ul class="document-toc-list"><li class="document-toc-item "><a class="document-toc-link" href="#ベースライン_github-flavored_markdown">ベースライン: GitHub-Flavored Markdown</a></li><li class="document-toc-item "><a class="document-toc-link" href="#リンク">リンク</a></li><li class="document-toc-item "><a class="document-toc-link" href="#コードブロックの例">コードブロックの例</a></li><li class="document-toc-item "><a class="document-toc-link" href="#メモ、警告、コールアウト">メモ、警告、コールアウト</a></li><li class="document-toc-item "><a class="document-toc-link" href="#定義リスト">定義リスト</a></li><li class="document-toc-item "><a class="document-toc-link" href="#表">表</a></li><li class="document-toc-item "><a class="document-toc-link" href="#上付き・下付き文字">上付き・下付き文字</a></li><li class="document-toc-item "><a class="document-toc-link" href="#ページ概要">ページ概要</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="ja"><header><h1>Markdown の書き方</h1></header><div class="section-content"><p>このページでは、 Markdown を使用してどのように MDN Web Docs のドキュメントを書くかを説明します。ベースラインとして GitHub-Flavored Markdown (GFM) を選択し、 GFM では容易にサポートされていない MDN で行う必要のあるいくつかのことに対応するために、いくつかの拡張機能を追加しました。</p></div><section aria-labelledby="ベースライン_github-flavored_markdown"><h2 id="ベースライン_github-flavored_markdown"><a href="#ベースライン_github-flavored_markdown">ベースライン: GitHub-Flavored Markdown</a></h2><div class="section-content"><p>MDN Markdown のベースラインは GitHub-Flavored Markdown (GFM、 <a href="https://github.github.com/gfm/" class="external" target="_blank">https://github.github.com/gfm/</a>) です。つまり、このページで明示的に指定していない仕様については、 GFM 仕様を参照してください。 GFM は CommonMark (<a href="https://spec.commonmark.org/" class="external" target="_blank">https://spec.commonmark.org/</a>) の上位互換です。</p></div></section><section aria-labelledby="リンク"><h2 id="リンク"><a href="#リンク">リンク</a></h2><div class="section-content"><p>GFM 仕様書では、基本的に 2 種類のリンクを定義しています。</p> <ul> <li><a href="https://github.github.com/gfm/#inline-link" class="external" target="_blank">インラインリンク</a>は、リンク先をリンクテキストの直後に指定します。</li> <li><a href="https://github.github.com/gfm/#reference-link" class="external" target="_blank">リファレンスリンク</a>は、リンク先を文書内の他の場所で定義します。</li> </ul> <p>MDN では、インラインリンクのみが利用できます。</p> <p>MDN で GFM リンクを書くには、これが正しい方法です。</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>これは 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="コードブロックの例"><h2 id="コードブロックの例"><a href="#コードブロックの例">コードブロックの例</a></h2><div class="section-content"><p>GFM や CommonMark では、「コードフェンス」を使用して <code><pre></code> ブロックを区切ることができます。冒頭のコードフェンスの後には、「情報文字列」と呼ばれるテキストが続くことがあります。仕様書には次のように書かれています。</p> <blockquote> <p>情報文字列の最初の単語は、通常、コードサンプルの言語を指定するために使用され、コードタグの class 属性に表示されます。</p> </blockquote> <p>情報文字列には、次のように複数の単語を含めることができます。</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>MDN では、書き手はコードブロックのサンプルにコードフェンスを使用します。書き手は情報文字列の最初の単語を使用してコードサンプルの言語を指定する必要があり、これはブロックの構文強調表示を提供するために使用されます。以下の単語に対応しています。</p> <ul> <li>プログラミング言語 <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 シェーダー)</li> <li><code>sql</code> - SeQueL コマンド</li> <li><code>wasm</code> - WebAssembly</li> <li><code>webidl</code> - Web Interface Definition Language</li> </ul> </li> </ul> </li> <li>スタイル設定 <ul> <li><code>css</code> - CSS</li> <li><code>scss</code> - Sass (SCSS)</li> <li><code>less</code> - Less</li> </ul> </li> <li>マークアップ <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>コマンドプロンプト <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>設定/データファイル <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 データベース</li> <li><code>ignore</code> - Gitignore ファイル</li> <li><code>apacheconf</code> - Apache 設定ファイル</li> <li><code>nginx</code> - NGINX 設定ファイル</li> </ul> </li> <li>テンプレート <ul> <li><code>django</code> - Django テンプレート</li> <li><code>svelte</code> - Svelte テンプレート</li> <li><code>handlebars</code> - Handlebars テンプレート</li> <li><code>pug</code> - <a href="https://pugjs.org/api/getting-started.html" class="external" target="_blank">Pug テンプレート</a> （<a href="/en-US/docs/Learn/Server-side/Express_Nodejs/Displaying_data/Template_primer" class="only-in-en-us" title="このページは現在、英語のみで利用可能です。">Express</a> で使用される可能性がある）</li> </ul> </li> <li>その他 <ul> <li><code>plain</code> - プレーンテキスト</li> <li><code>diff</code> - 差分ファイル</li> <li><code>http</code> - HTTP ヘッダー</li> <li><code>regex</code> - 正規表現</li> <li><code>uri</code> - URI および URL</li> </ul> </li> </ul> <p>例えば、次のようにします。</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> 使用したいハイライトが上記に掲載されていない場合は、コードブロックを <code>plain</code> としてマークアップしてください。 <a href="https://github.com/orgs/mdn/discussions/170#discussioncomment-3404366" class="external" target="_blank">GitHub での議論</a>の過程で、追加の言語がリクエストされるかもしれません。 </p></div></section><section aria-labelledby="リンターの抑制"><h3 id="リンターの抑制"><a href="#リンターの抑制">リンターの抑制</a></h3><div class="section-content"><p>書き手はどの言語識別子にも、接尾辞 <code>-nolint</code> を追加することができます。</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>このようなコードブロックは適切な構文強調表示が行われ、ライブサンプルシステムで認識されますが、リンターや Prettier のような自動フォーマッターでは無視されます。下記てはこの接尾辞を、リンターや書式化ツールが修正すべきでない不正なコードや代替書式を表示するために使用してください。</p></div></section><section aria-labelledby="追加クラス（情報文字列）"><h3 id="追加クラス（情報文字列）"><a href="#追加クラス（情報文字列）">追加クラス（情報文字列）</a></h3><div class="section-content"><p>GFM では<a href="https://github.github.com/gfm/#info-string" class="external" target="_blank">情報文字列</a>に対応しており、コードブロックに関する追加情報を記述することができます。 MDN では、情報文字列はクラス名に変換されます。</p> <p>書き手は以下の追加の単語のいずれかを使用することができますが、これらの単語は言語の単語の後に置く必要があります。</p> <ul> <li><code>example-good</code>: この例を良い例 (採用すべきもの) としてスタイル付けする</li> <li><code>example-bad</code>: この例を悪い例 (避けるべきもの) としてスタイル付けする</li> <li><code>hidden</code>: このコードブロックをページに表示しません。これはライブサンプルで使用するためのものです。</li> </ul> <p>例:</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>これらは以下のように表示されます。</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="議論リファレンス"><h3 id="議論リファレンス"><a href="#議論リファレンス">議論リファレンス</a></h3><div class="section-content"><p>この課題は次で解決しました。</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="メモ、警告、コールアウト"><h2 id="メモ、警告、コールアウト"><a href="#メモ、警告、コールアウト">メモ、警告、コールアウト</a></h2><div class="section-content"><p>コンテンツの一部に特別な注意を喚起したい場合があります。そのためには、特別な最初の段落を持つ GFM ブロック引用を使用します。 GFM ブロック引用には、「メモ」「警告」「コールアウト」の 3 種類があります。</p> <ul> <li>メモを追加するには、 GFM ブロック引用の最初の段落を <code>**メモ:**</code> で始めてください。</li> <li>警告を追加するには、 GFM ブロック引用の最初の段落を <code>**警告:**</code> で始めてください。</li> <li>コールアウトを追加するには、 GFM ブロック引用の最初の段落を <code>**注目:**</code> で始めてください。</li> </ul> <p>メモと警告は、出力に <strong>メモ:</strong> または <strong>警告:</strong> というテキストが表示されますが、コールアウトは表示されません。このため、コールアウトは、独自のタイトルを提供したい場合に適しています。</p> <p>マークアップの処理は、指定された正確な文字ではなく、生成された AST に基づいて行われます。つまり、 <code><strong>メモ:</strong></code> もメモを生成します。ただし、スタイルの問題として Markdown の構文が必要です。</p> <p>複数行は、通常の段落と同じように、空のブロック引用行によって生成されます。さらに、スペースのない複数の行は通常の Markdown の行と同様に扱われ、連結されます。</p> <p>ブロック引用には、コードブロックやその他のブロック要素を含めることができます。</p></div></section><section aria-labelledby="例"><h3 id="例"><a href="#例">例</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] > これがメモの書き方です。 > > 複数行を入れることもできます。 </code></pre></div> <p>これで次のような 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>メモ:</strong> これがメモの書き方です。</p> <p>複数行を入れることもできます。</p> </div> </code></pre></div> <p>この HTML は次のように、強調ボックスとして描画されます。</p> <div class="notecard note"> <p><strong>メモ:</strong> これがメモの書き方です。</p> <p>複数行を入れることもできます。</p> </div> <h4 id="警告（英語版では_warning）">警告（英語版では Warning）</h4> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>> [!WARNING] > これが警告の書き方です。 > > 複数の段落を入れることもできます。 </code></pre></div> <p>これで次のような 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>警告:</strong> これが警告の書き方です。</p> <p>複数の段落を入れることもできます。</p> </div> </code></pre></div> <p>この HTML は次のように、強調ボックスとして描画されます。</p> <div class="notecard warning"> <p><strong>警告:</strong> これが警告の書き方です。</p> <p>複数の段落を入れることもできます。</p> </div> <h4 id="コールアウト（英語版では_callout）">コールアウト（英語版では Callout）</h4> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>> **注目:** **これがコールアウトの書き方です。** > > 複数の段落を入れることもできます。 </code></pre></div> <p>これで次のような 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>これがコールアウトの書き方です。</strong></p> <p>複数の段落を入れることもできます。</p> </div> </code></pre></div> <p>この HTML は次のように、強調ボックスとして描画されます。</p> <div class="callout"> <p><strong>これがコールアウトの書き方です。</strong></p> <p>複数の段落を入れることもできます。</p> </div> <h4 id="翻訳された警告">翻訳された警告</h4> <p>"Note:" や "Warning:" はレンダリング出力にも現れるので、翻訳に対応させる必要があります。実際には、 MDN が対応しているすべてのロケールがこれらの文字列を自分自身で翻訳し、プラットフォームが特別な対応が必要であることを示すものとして認識しなければならないことを意味します。</p> <p>ローカライズは <a href="https://www.gnu.org/software/gettext/" class="external" target="_blank">gettext</a> 形式の JSON ファイルとして <a href="https://github.com/mdn/yari/tree/main/markdown/localizations" class="external" target="_blank">Yari</a> に格納されています。これらのファイルを参照して、そのロケールの "Note:" や "Warning:" の代わりに使用する文字列を決定してください。ロケールファイルを定義されていない場合、フォールバックとして英語が使用されます。</p> <p>例えば、ドイツ語の "Warnung" を "Warning" に使用した場合、ドイツ語のページではこう書きます。</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>> [!WARNING] > So schreibt man eine Warnung. </code></pre></div> <p>これは次のように表示されます。</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>Warnung:</strong> So schreibt man eine Warnung.</p> </div> </code></pre></div> <h4 id="コードブロックを含むメモ">コードブロックを含むメモ</h4> <p>この例はコードブロックを含んでいます。</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>> [!NOTE] > これがメモの書き方です。 > > コードブロックを含むことができます。 > > ```js > const s = "コードブロックの中です"; > ``` > > こんな感じです。 </code></pre></div> <p>これで次のような 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> これがメモの書き方です。</p> <p>コードブロックを含むことができます。</p> <pre class="brush: js">const s = "コードブロックの中です";</pre> <p>こんな感じです。</p> </div> </code></pre></div> <p>この HTML は次のようにコードブロックと一緒に描画されます。</p> <div class="notecard note"> <p><strong>メモ:</strong> これがメモの書き方です。</p> <p>コードブロックを含むことができます。.</p> <div class="code-example"><div class="example-header"><span class="language-name">js</span></div><pre class="brush: js notranslate"><code>const s = "コードブロックの中です"; </code></pre></div> <p>こんな感じです。</p> </div></div></section><section aria-labelledby="議論リファレンス_2"><h3 id="議論リファレンス_2"><a href="#議論リファレンス_2">議論リファレンス</a></h3><div class="section-content"><p>この課題は <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="定義リスト"><h2 id="定義リスト"><a href="#定義リスト">定義リスト</a></h2><div class="section-content"><p>定義リストは MDN では一般的に使用されていますが、 GFM では対応していません。 MDN では定義リスト用に独自の形式を導入しており、これは GFM の順序なしリスト (<a href="/ja/docs/Web/HTML/Element/ul"><code><ul></code></a>) を変形した形式です。この形式では、</p> <ul> <li>GFM <code><ul></code> は任意の数の最上位の GFM <code><li></code> 要素を含みます。</li> <li>最上位の GFM <code><li></code> 要素は、最後の要素として GFM <code><ul></code> 要素を含みます。</li> <li>最終的に含まれる <code><ul></code> は、単一の GFM <code><li></code> 要素を含み、この中身は ": " (コロンに続いて空白) で始まるテキストでなければなりません。この要素はブロック要素、例えば段落、コードブロック、埋め込みリスト、メモなどを含むことができます。</li> </ul> <p>最上位の GFM <code><li></code> 要素は、次のように <code><dt></code>/<code><dd></code> の組に変換されます。</p> <ul> <li>最上位の GFM <code><li></code> 要素は、GFM <code><li></code> 要素として解析され、その内部コンテンツは、 <code><dt></code> の内容を構成しますが、最後に入れ子になった <code><ul></code> については例外で、 <code><dt></code> には含まれません。</li> <li>最後に入れ子になった <code><ul></code> の中の <code><li></code> 要素は、GFM <code><li></code> 要素として解析され、その内容は <code><dd></code> の内容を構成しますが、先頭の <code>:</code> は捨てられます。</li> </ul> <p>例えば、これは <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 複数の段落やコードブロックを格納することもできます。 ```js const thing = 1; ``` </code></pre></div> <p>GFM/CommonMark では、これは次の 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>MDN では、これは次の 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>この構文で書かれた定義リストは、 <code><dt></code>/<code><dd></code> 要素のペアで構成されます。この構文では、 2 つ以上の連続した <code><dt></code> 要素、または 2 つ以上の連続した <code><dd></code> 要素を持つリストを書くことはできません。パーサーはこれをエラーとして扱います。 MDN 上のほとんどすべての定義リストがこの制限で動作することを期待しており、動作しないものについては、生の HTML に戻ることができます。</p> <p>以下のものは許可されていません。</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>複数の <code><dt></code> 項目を 1 つの <code><dd></code> に関連付ける必要がある場合の回避策として、以下のように複数の用語をカンマで区切って 1 つの <code><dt></code> として提供することを検討してください。</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>ここで説明する構文の根拠は、 CommonMark を期待するツール (Prettier や GitHub のプレビューなど) で十分に機能すると同時に、記述と解析が適度に簡単であることです。</p></div></section><section aria-labelledby="議論リファレンス_3"><h3 id="議論リファレンス_3"><a href="#議論リファレンス_3">議論リファレンス</a></h3><div class="section-content"><p>この課題は <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="表"><h2 id="表"><a href="#表">表</a></h2><div class="section-content"><p>GFM は<a href="https://github.github.com/gfm/#tables-extension-" class="external" target="_blank">表</a>を作成する構文を提供しており、 MDN ではそれを使用しています。しかし、 GFM の表が私たちのニーズに合わない場合もあります。</p> <ul> <li>GFM の構文は HTML で利用可能な機能の一部しか対応していません。 GFM で対応していない表の機能を使う必要がある場合は、表を表現するのに HTML を使用してください。</li> <li>GFM による表の表現が幅 150 文字を超える場合は、 HTML の表を使用してください。</li> <li>「プロパティ表」と呼ばれる特殊な種類の表があり、独自の CSS クラスがあります。その場合は常に HTML を使用してください。</li> </ul> <p>ですから、ここでの一般的な原則は、可能な限り GFM Markdown の構文を使用しますが、 HTML を使用する必要がある場合、その方が読みやすい場合は生の HTML に立ち戻ってください。下記の <a href="#html_%E8%A1%A8%E3%82%92%E4%BD%BF%E7%94%A8%E3%81%99%E3%82%8B%E5%A0%B4%E5%90%88">HTML 表を使用する場合</a>を参照してください。</p></div></section><section aria-labelledby="gfm_の表の構文"><h3 id="gfm_の表の構文"><a href="#gfm_の表の構文">GFM の表の構文</a></h3><div class="section-content"><p>GFM の表構文では、行の先頭と末尾のパイプを省略できます。しかし、 MDN では読み取り可能なように、これらのパイプを記載しなければなりません。また、行の末尾に空間を提供し、段組みのセルがすべて同じ長さになるようにしなければなりません。</p> <p>つまり、 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>| Heading 1 | Heading 2 | Heading 3 | | --------- | --------- | --------- | | cell 1 | cell 2 | cell 3 | | cell 4 | cell 5 | cell 6 | </code></pre></div> <p>このスタイルではありません。</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>幸いなことに、表の書式は Prettier によって自動修正されるので、書き手は Prettier に頼って表を適切に整形することができます。</p></div></section><section aria-labelledby="html_表を使用する場合"><h3 id="html_表を使用する場合"><a href="#html_表を使用する場合">HTML 表を使用する場合</a></h3><div class="section-content"><p>書き手が GFM 構文ではなく HTML 表を使用すべき主な状況は 3 つあります。</p> <ol> <li>表は GFM では対応していない機能（下記参照）を使用する場合。</li> <li>GFM お表の幅が広すぎて読みにくい場合。</li> <li>書き手が「プロパティテーブル」と呼ばれる特殊な表を使いたい場合。</li> </ol> <h4 id="gfm_が対応していない表機能">GFM が対応していない表機能</h4> <p>GFM 表構文の主な制限事項は以下の通りです。</p> <ul> <li>GFM の表ではヘッダー行が必要です。</li> <li>GFM の表ではヘッダー列を設定することができません。</li> <li>GFM は表のセル内にある GFM ブロック要素を解析しません。例えば、表のセル内にリストを入れることはできません。</li> <li>GFM の表にはクラスを割り当てることはできません。</li> <li>GFM は <code><table></code>, <code><tr></code>, <code><th></code>, <code><td></code> 以外の表要素に対応していません。</li> <li>GFM は <code>colspan</code>, <code>rowspan</code>, <code>scope</code> のような表要素の属性に対応していません。</li> </ul> <p>もし、対応していない機能を使う必要がある場合は、 HTML で表を作成する必要があります。</p> <p>なお、表に <code><caption></code> 要素を使うことは、 GFM 構文からも排除されるため、一般的にはお勧めしません。</p> <h4 id="gfm_表の最大幅">GFM 表の最大幅</h4> <p>GFM では、表を「<a href="/ja/docs/Glossary/ASCII">ASCII</a> アート」で表現しているため、表が長くなると読みづらくなります。たとえば、次のような表があるとします。</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>見出し 1</th> <th>見出し 2</th> <th>見出し 3</th> <th>見出し 4</th> <th>見出し 5</th> <th>見出し 6</th> </tr> <tr> <td>短めのもの</td> <td> GFM の書式では表組みが崩れてしまうほど、何かについて本当に詳しく書かれている長いもの。 </td> <td>短めのもの</td> <td> また、何かについて実に詳しく書かれている、大量のテキストを含むセルは、 GFM の書式では表の書式が崩れ始めてしまいます。 </td> <td>短めのもの</td> <td>短めのもの</td> </tr> </table> </code></pre></div> <p>GFM ではこのようになります。</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>| 見出し 1 | 見出し 2 | 見出し 3 | 見出し 4 | 見出し 5 | 見出し 6 | | ---------- | -------------------------------------------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | ---------- | | 短めのもの | GFM の書式では表組みが崩れてしまうほど、何かについて本当に詳しく書かれている長いもの。 | 短めのもの | また、何かについて実に詳しく書かれている、大量のテキストを含むセルは、 GFM の書式では表の書式が崩れ始めてしまいます。 | 短めのもの | 短めのもの | </code></pre></div> <p>このような場合は、HTML を使用するのがよいでしょう。</p> <p>これにより導かれるガイドラインは、表の Markdown 表現が幅 150 文字以上になる場合、その表には HTML を使用することです。</p> <h4 id="プロパティ表">プロパティ表</h4> <p>プロパティ表は特定の種類の表で、特定の型のページ同士でまたがって使用される、構造化されたプロパティ値を表示するために使用されるものです。これらの表には 2 つの列があります。最初の列はヘッダー列で、プロパティを列挙し、2 番目の列にはこの特定の項目に関する値を列挙します。例えば、以下は <a href="/ja/docs/Web/API/PannerNode"><code>PannerNode</code></a> インターフェイスのプロパティ表です。</p> <figure class="table-container"><table class="properties"> <tbody> <tr> <th scope="row">入力数</th> <td><code>1</code></td> </tr> <tr> <th scope="row">出力数</th> <td><code>0</code></td> </tr> <tr> <th scope="row">チャンネルの数え方</th> <td><code>"explicit"</code></td> </tr> <tr> <th scope="row">チャンネル数</th> <td><code>2</code></td> </tr> <tr> <th scope="row">チャンネルの意味</th> <td><code>"speakers"</code></td> </tr> </tbody> </table></figure> <p> これらのページはヘッダー列があるため、 GFM では表せませんので、この場合は HTML を使用しましょう。特殊なスタイルにするには、 <code>"properties"</code> クラスを表に適用する必要があります。 </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="議論リファレンス_4"><h3 id="議論リファレンス_4"><a href="#議論リファレンス_4">議論リファレンス</a></h3><div class="section-content"><p>この課題は <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>, <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="上付き・下付き文字"><h2 id="上付き・下付き文字"><a href="#上付き・下付き文字">上付き・下付き文字</a></h2><div class="section-content"><p>HTML の <a href="/ja/docs/Web/HTML/Element/sup"><code><sup></code></a> および <a href="/ja/docs/Web/HTML/Element/sub"><code><sub></code></a> 要素を必要に応じて使用することができますが、可能な限り代替策を採ってください。具体的には次のようにします。</p> <ul> <li>べき乗については、 <code>2^53</code> のようにキャレットを使用してください。</li> <li>1<sup>st</sup> のような序数表現では、 "first" のように言葉を使用してください。</li> <li>脚注については、脚注参照を <code><sup>[1]</sup></code> のようにマークアップしないでください。必要ありません。</li> </ul></div></section><section aria-labelledby="議論リファレンス_5"><h3 id="議論リファレンス_5"><a href="#議論リファレンス_5">議論リファレンス</a></h3><div class="section-content"><p>この課題は <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="ページ概要"><h2 id="ページ概要"><a href="#ページ概要">ページ概要</a></h2><div class="section-content"><p>ページ概要はページの最初の「コンテンツ」の段落で、ページのフロントマターや<a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Macros/Commonly_used_macros#%E3%82%B5%E3%82%A4%E3%83%89%E3%83%90%E3%83%BC%E3%81%AE%E7%94%9F%E6%88%90">サイドバー</a>や<a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Macros/Commonly_used_macros#%E3%83%9A%E3%83%BC%E3%82%B8%E3%81%BE%E3%81%9F%E3%81%AF%E3%82%BB%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%AE%E3%83%98%E3%83%83%E3%83%80%E3%83%BC%E3%82%92%E7%A4%BA%E3%81%99%E3%82%A4%E3%83%B3%E3%82%B8%E3%82%B1%E3%83%BC%E3%82%BF%E3%83%BC">ページバナー</a>マクロの後に現れる最初のテキストです。</p> <p> この概要は検索エンジン最適化 (SEO) のために使用され、また、マクロによってはページリストに自動的に含まれます。したがって、最初の段落は、簡潔で説明的なものでなければなりません。 </p></div></section><section aria-labelledby="議論リファレンス_6"><h3 id="議論リファレンス_6"><a href="#議論リファレンス_6">議論リファレンス</a></h3><div class="section-content"><p>この課題は <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>文章のコンテンツに、 KumaScript のマクロ呼び出しを含めることができます。</p> <div class="code-example"><div class="example-header"><span class="language-name">md</span></div><pre class="brush: md notranslate"><code>**`margin`** は [CSS](/ja/docs/Web/CSS) のプロパティで、要素の全 4 辺のマージン領域を設定します。これは {{cssxref("margin-top")}}, {{cssxref("margin-right")}}, {{cssxref("margin-bottom")}}, {{cssxref("margin-left")}} の一括指定です。 {{EmbedInteractiveExample("pages/css/margin.html")}} 上下のマージンは置換インライン要素、例えば {{HTMLElement("span")}} や {{HTMLElement("code")}} では効果がありません。 </code></pre></div> <p>マクロについてのより詳しい情報は、<a href="/ja/docs/MDN/Writing_guidelines/Page_structures/Macros">マクロの使用</a>を参照してください。</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/translated-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-07-28T08:23:52.000Z">2024年7月28日</time> by <a href="/ja/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/translated-content/blob/main/files/ja/mdn/writing_guidelines/howto/markdown_in_mdn/index.md?plain=1" title="Folder: ja/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/translated-content/issues/new?template=page-report-ja.yml&mdn-url=https%3A%2F%2Fdeveloper.mozilla.org%2Fja%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+%60ja%2Fmdn%2Fwriting_guidelines%2Fhowto%2Fmarkdown_in_mdn%60%0A*+MDN+URL%3A+https%3A%2F%2Fdeveloper.mozilla.org%2Fja%2Fdocs%2FMDN%2FWriting_guidelines%2FHowto%2FMarkdown_in_MDN%0A*+GitHub+URL%3A+https%3A%2F%2Fgithub.com%2Fmdn%2Ftranslated-content%2Fblob%2Fmain%2Ffiles%2Fja%2Fmdn%2Fwriting_guidelines%2Fhowto%2Fmarkdown_in_mdn%2Findex.md%0A*+Last+commit%3A+https%3A%2F%2Fgithub.com%2Fmdn%2Ftranslated-content%2Fcommit%2F10c079c862b80d3fe62f49a1b0e92c2329cad4bd%0A*+Document+last+modified%3A+2024-07-28T08%3A23%3A52.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="/ja/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="/ja/docs/Web">Web Technologies</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/ja/docs/Learn">Learn Web Development</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/ja/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="/ja/docs/MDN/Writing_guidelines/Attrib_copyright_license">a Creative Commons license</a>.</p></div></div></footer></div><script type="application/json" id="hydration">{"url":"/ja/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN","doc":{"isMarkdown":true,"isTranslated":true,"isActive":true,"flaws":{},"title":"Markdown の書き方","mdn_url":"/ja/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN","locale":"ja","native":"日本語","sidebarHTML":"<ol><li><a href=\"/ja/docs/MDN\">MDN Web Docs プロジェクト</a></li><li class=\"toggle\"><details><summary>Community guidelines</summary><ol><li><a href=\"/ja/docs/MDN/Community\">コミュニティガイドライン</a></li><li class=\"toggle\"><details><summary>Contributing to MDN Web Docs</summary><ol><li><a href=\"/ja/docs/MDN/Community/Contributing\">MDN Web Docs への協力</a></li><li><a href=\"/ja/docs/MDN/Community/Contributing/Getting_started\">MDN を始めよう</a></li><li><a href=\"/ja/docs/MDN/Community/Contributing/Our_repositories\">MDN Web Docs のリポジトリー</a></li><li><a href=\"/ja/docs/MDN/Community/Contributing/Translated_content\">MDN Web Docs のローカライズ</a></li><li><a href=\"/ja/docs/MDN/Community/Contributing/Security_vulnerability_response\">セキュリティ脆弱性への対応策</a></li></ol></details></li><li><a href=\"/ja/docs/MDN/Community/Open_source_etiquette\">オープンソースのエチケット</a></li><li><a href=\"/ja/docs/MDN/Community/Communication_channels\">コミュニケーション手段</a></li><li><a href=\"/ja/docs/MDN/Community/Discussions\">コミュニティのディスカッション</a></li><li><a href=\"/ja/docs/MDN/Community/Learn_forum\">学習フォーラム</a></li><li><a href=\"/ja/docs/MDN/Community/Issues\">課題の作成と作業のガイドライン</a></li><li><a href=\"/ja/docs/MDN/Community/Pull_requests\">プルリクエストの提出とレビューのガイドライン</a></li><li><a href=\"/ja/docs/MDN/Community/Roles_teams\">MDN Web Docs の役割とチーム</a></li></ol></details></li><li class=\"toggle\"><details open=\"\"><summary>Writing guidelines</summary><ol><li><a href=\"/ja/docs/MDN/Writing_guidelines\">執筆ガイドライン</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/What_we_write\">私たちが書くもの</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Writing_style_guide\">執筆スタイルガイド</a></li><li class=\"toggle\"><details open=\"\"><summary>How-to guides</summary><ol><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto\">How-to ガイド</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Images_media\">画像やメディアの追加方法</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting\">ページの作成、移動、削除、編集方法</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Document_a_CSS_property\">CSS プロパティの記事の作成方法</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Document_an_HTTP_header\">HTTP ヘッダーの記事の作成方法</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Document_web_errors\">ウェブのエラー記事の作成方法</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Research_technology\">技術の調査方法</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data\">構造化データの使用方法</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference\">API リファレンスの書き方</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary\">用語集の項目を執筆する方法</a></li><li><em><a href=\"/ja/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN\" aria-current=\"page\">Markdown の書き方</a></em></li></ol></details></li><li class=\"toggle\"><details><summary>Page structures</summary><ol><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures\">文書の構造</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Banners_and_notices\">バナーと注意</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Code_examples\">コードサンプル</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables\">互換性一覧表とブラウザー互換性データリポジトリー (BCD)</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Live_samples\">ライブサンプル</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Page_types\">ページの種類</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Sidebars\">サイドバー</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Specification_tables\">仕様書一覧表</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Syntax_sections\">構文の節</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Macros\">マクロの使用</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Feature_status\">機能状態</a></li></ol></details></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Attrib_copyright_license\">帰属表示と著作権使用許諾</a></li><li><a href=\"/ja/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete\">実験的、非推奨、廃止</a></li></ol></details></li><li class=\"toggle\"><details><summary>Advisory Board</summary><ol><li><a href=\"/ja/docs/MDN/MDN_Product_Advisory_Board\">MDN 製品諮問委員会</a></li><li><a href=\"/ja/docs/MDN/MDN_Product_Advisory_Board/Membership\">製品諮問委員会憲章および会員資格</a></li></ol></details></li><li class=\"toggle\"><details><summary>History</summary><ol><li><a href=\"/ja/docs/MDN/At_ten\">MDN は 10 周年を迎えました</a></li><li><a href=\"/ja/docs/MDN/At_ten/History_of_MDN\">MDN のあゆみ</a></li></ol></details></li><li><a href=\"/ja/docs/MDN/Changelog\">MDN Web Docs の変更履歴</a></li></ol>","sidebarMacro":"MDNSidebar","body":[{"type":"prose","value":{"id":null,"title":null,"isH3":false,"content":"<p>このページでは、 Markdown を使用してどのように MDN Web Docs のドキュメントを書くかを説明します。ベースラインとして GitHub-Flavored Markdown (GFM) を選択し、 GFM では容易にサポートされていない MDN で行う必要のあるいくつかのことに対応するために、いくつかの拡張機能を追加しました。</p>"}},{"type":"prose","value":{"id":"ベースライン_github-flavored_markdown","title":"ベースライン: GitHub-Flavored Markdown","isH3":false,"content":"<p>MDN Markdown のベースラインは GitHub-Flavored Markdown (GFM、 <a href=\"https://github.github.com/gfm/\" class=\"external\" target=\"_blank\">https://github.github.com/gfm/</a>) です。つまり、このページで明示的に指定していない仕様については、 GFM 仕様を参照してください。 GFM は CommonMark (<a href=\"https://spec.commonmark.org/\" class=\"external\" target=\"_blank\">https://spec.commonmark.org/</a>) の上位互換です。</p>"}},{"type":"prose","value":{"id":"リンク","title":"リンク","isH3":false,"content":"<p>GFM 仕様書では、基本的に 2 種類のリンクを定義しています。</p>\n<ul>\n <li><a href=\"https://github.github.com/gfm/#inline-link\" class=\"external\" target=\"_blank\">インラインリンク</a>は、リンク先をリンクテキストの直後に指定します。</li>\n <li><a href=\"https://github.github.com/gfm/#reference-link\" class=\"external\" target=\"_blank\">リファレンスリンク</a>は、リンク先を文書内の他の場所で定義します。</li>\n</ul>\n<p>MDN では、インラインリンクのみが利用できます。</p>\n<p>MDN で GFM リンクを書くには、これが正しい方法です。</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>これは 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":"コードブロックの例","title":"コードブロックの例","isH3":false,"content":"<p>GFM や CommonMark では、「コードフェンス」を使用して <code><pre></code> ブロックを区切ることができます。冒頭のコードフェンスの後には、「情報文字列」と呼ばれるテキストが続くことがあります。仕様書には次のように書かれています。</p>\n<blockquote>\n <p>情報文字列の最初の単語は、通常、コードサンプルの言語を指定するために使用され、コードタグの class 属性に表示されます。</p>\n</blockquote>\n<p>情報文字列には、次のように複数の単語を含めることができます。</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>MDN では、書き手はコードブロックのサンプルにコードフェンスを使用します。書き手は情報文字列の最初の単語を使用してコードサンプルの言語を指定する必要があり、これはブロックの構文強調表示を提供するために使用されます。以下の単語に対応しています。</p>\n<ul>\n <li>プログラミング言語\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 シェーダー)</li>\n <li><code>sql</code> - SeQueL コマンド</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>スタイル設定\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>マークアップ\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>コマンドプロンプト\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>設定/データファイル\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 データベース</li>\n <li><code>ignore</code> - Gitignore ファイル</li>\n <li><code>apacheconf</code> - Apache 設定ファイル</li>\n <li><code>nginx</code> - NGINX 設定ファイル</li>\n </ul>\n </li>\n <li>テンプレート\n <ul>\n <li><code>django</code> - Django テンプレート</li>\n <li><code>svelte</code> - Svelte テンプレート</li>\n <li><code>handlebars</code> - Handlebars テンプレート</li>\n <li><code>pug</code> - <a href=\"https://pugjs.org/api/getting-started.html\" class=\"external\" target=\"_blank\">Pug テンプレート</a> （<a href=\"/en-US/docs/Learn/Server-side/Express_Nodejs/Displaying_data/Template_primer\" class=\"only-in-en-us\" title=\"このページは現在、英語のみで利用可能です。\">Express</a> で使用される可能性がある）</li>\n </ul>\n </li>\n <li>その他\n <ul>\n <li><code>plain</code> - プレーンテキスト</li>\n <li><code>diff</code> - 差分ファイル</li>\n <li><code>http</code> - HTTP ヘッダー</li>\n <li><code>regex</code> - 正規表現</li>\n <li><code>uri</code> - URI および URL</li>\n </ul>\n </li>\n</ul>\n<p>例えば、次のようにします。</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 使用したいハイライトが上記に掲載されていない場合は、コードブロックを <code>plain</code> としてマークアップしてください。\n <a href=\"https://github.com/orgs/mdn/discussions/170#discussioncomment-3404366\" class=\"external\" target=\"_blank\">GitHub での議論</a>の過程で、追加の言語がリクエストされるかもしれません。\n</p>"}},{"type":"prose","value":{"id":"リンターの抑制","title":"リンターの抑制","isH3":true,"content":"<p>書き手はどの言語識別子にも、接尾辞 <code>-nolint</code> を追加することができます。</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>このようなコードブロックは適切な構文強調表示が行われ、ライブサンプルシステムで認識されますが、リンターや Prettier のような自動フォーマッターでは無視されます。下記てはこの接尾辞を、リンターや書式化ツールが修正すべきでない不正なコードや代替書式を表示するために使用してください。</p>"}},{"type":"prose","value":{"id":"追加クラス（情報文字列）","title":"追加クラス（情報文字列）","isH3":true,"content":"<p>GFM では<a href=\"https://github.github.com/gfm/#info-string\" class=\"external\" target=\"_blank\">情報文字列</a>に対応しており、コードブロックに関する追加情報を記述することができます。 MDN では、情報文字列はクラス名に変換されます。</p>\n<p>書き手は以下の追加の単語のいずれかを使用することができますが、これらの単語は言語の単語の後に置く必要があります。</p>\n<ul>\n <li><code>example-good</code>: この例を良い例 (採用すべきもの) としてスタイル付けする</li>\n <li><code>example-bad</code>: この例を悪い例 (避けるべきもの) としてスタイル付けする</li>\n <li><code>hidden</code>: このコードブロックをページに表示しません。これはライブサンプルで使用するためのものです。</li>\n</ul>\n<p>例:</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>これらは以下のように表示されます。</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":"議論リファレンス","title":"議論リファレンス","isH3":true,"content":"<p>この課題は次で解決しました。</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":"メモ、警告、コールアウト","title":"メモ、警告、コールアウト","isH3":false,"content":"<p>コンテンツの一部に特別な注意を喚起したい場合があります。そのためには、特別な最初の段落を持つ GFM ブロック引用を使用します。 GFM ブロック引用には、「メモ」「警告」「コールアウト」の 3 種類があります。</p>\n<ul>\n <li>メモを追加するには、 GFM ブロック引用の最初の段落を <code>**メモ:**</code> で始めてください。</li>\n <li>警告を追加するには、 GFM ブロック引用の最初の段落を <code>**警告:**</code> で始めてください。</li>\n <li>コールアウトを追加するには、 GFM ブロック引用の最初の段落を <code>**注目:**</code> で始めてください。</li>\n</ul>\n<p>メモと警告は、出力に <strong>メモ:</strong> または <strong>警告:</strong> というテキストが表示されますが、コールアウトは表示されません。このため、コールアウトは、独自のタイトルを提供したい場合に適しています。</p>\n<p>マークアップの処理は、指定された正確な文字ではなく、生成された AST に基づいて行われます。つまり、 <code><strong>メモ:</strong></code> もメモを生成します。ただし、スタイルの問題として Markdown の構文が必要です。</p>\n<p>複数行は、通常の段落と同じように、空のブロック引用行によって生成されます。さらに、スペースのない複数の行は通常の Markdown の行と同様に扱われ、連結されます。</p>\n<p>ブロック引用には、コードブロックやその他のブロック要素を含めることができます。</p>"}},{"type":"prose","value":{"id":"例","title":"例","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> これがメモの書き方です。\n>\n> 複数行を入れることもできます。\n</code></pre></div>\n<p>これで次のような 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>メモ:</strong> これがメモの書き方です。</p>\n <p>複数行を入れることもできます。</p>\n</div>\n</code></pre></div>\n<p>この HTML は次のように、強調ボックスとして描画されます。</p>\n<div class=\"notecard note\">\n <p><strong>メモ:</strong> これがメモの書き方です。</p>\n <p>複数行を入れることもできます。</p>\n</div>\n<h4 id=\"警告（英語版では_warning）\">警告（英語版では Warning）</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> これが警告の書き方です。\n>\n> 複数の段落を入れることもできます。\n</code></pre></div>\n<p>これで次のような 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>警告:</strong> これが警告の書き方です。</p>\n <p>複数の段落を入れることもできます。</p>\n</div>\n</code></pre></div>\n<p>この HTML は次のように、強調ボックスとして描画されます。</p>\n<div class=\"notecard warning\">\n <p><strong>警告:</strong> これが警告の書き方です。</p>\n <p>複数の段落を入れることもできます。</p>\n</div>\n<h4 id=\"コールアウト（英語版では_callout）\">コールアウト（英語版では Callout）</h4>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>> **注目:** **これがコールアウトの書き方です。**\n>\n> 複数の段落を入れることもできます。\n</code></pre></div>\n<p>これで次のような 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>これがコールアウトの書き方です。</strong></p>\n <p>複数の段落を入れることもできます。</p>\n</div>\n</code></pre></div>\n<p>この HTML は次のように、強調ボックスとして描画されます。</p>\n<div class=\"callout\">\n <p><strong>これがコールアウトの書き方です。</strong></p>\n <p>複数の段落を入れることもできます。</p>\n</div>\n<h4 id=\"翻訳された警告\">翻訳された警告</h4>\n<p>\"Note:\" や \"Warning:\" はレンダリング出力にも現れるので、翻訳に対応させる必要があります。実際には、 MDN が対応しているすべてのロケールがこれらの文字列を自分自身で翻訳し、プラットフォームが特別な対応が必要であることを示すものとして認識しなければならないことを意味します。</p>\n<p>ローカライズは <a href=\"https://www.gnu.org/software/gettext/\" class=\"external\" target=\"_blank\">gettext</a> 形式の JSON ファイルとして <a href=\"https://github.com/mdn/yari/tree/main/markdown/localizations\" class=\"external\" target=\"_blank\">Yari</a> に格納されています。これらのファイルを参照して、そのロケールの \"Note:\" や \"Warning:\" の代わりに使用する文字列を決定してください。ロケールファイルを定義されていない場合、フォールバックとして英語が使用されます。</p>\n<p>例えば、ドイツ語の \"Warnung\" を \"Warning\" に使用した場合、ドイツ語のページではこう書きます。</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>> [!WARNING]\n> So schreibt man eine Warnung.\n</code></pre></div>\n<p>これは次のように表示されます。</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>Warnung:</strong> So schreibt man eine Warnung.</p>\n</div>\n</code></pre></div>\n<h4 id=\"コードブロックを含むメモ\">コードブロックを含むメモ</h4>\n<p>この例はコードブロックを含んでいます。</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> これがメモの書き方です。\n>\n> コードブロックを含むことができます。\n>\n> ```js\n> const s = \"コードブロックの中です\";\n> ```\n>\n> こんな感じです。\n</code></pre></div>\n<p>これで次のような 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> これがメモの書き方です。</p>\n <p>コードブロックを含むことができます。</p>\n <pre class=\"brush: js\">const s = \"コードブロックの中です\";</pre>\n <p>こんな感じです。</p>\n</div>\n</code></pre></div>\n<p>この HTML は次のようにコードブロックと一緒に描画されます。</p>\n<div class=\"notecard note\">\n <p><strong>メモ:</strong> これがメモの書き方です。</p>\n <p>コードブロックを含むことができます。.</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 = \"コードブロックの中です\";\n</code></pre></div>\n <p>こんな感じです。</p>\n</div>"}},{"type":"prose","value":{"id":"議論リファレンス_2","title":"議論リファレンス","isH3":true,"content":"<p>この課題は <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":"定義リスト","title":"定義リスト","isH3":false,"content":"<p>定義リストは MDN では一般的に使用されていますが、 GFM では対応していません。 MDN では定義リスト用に独自の形式を導入しており、これは GFM の順序なしリスト (<a href=\"/ja/docs/Web/HTML/Element/ul\"><code><ul></code></a>) を変形した形式です。この形式では、</p>\n<ul>\n <li>GFM <code><ul></code> は任意の数の最上位の GFM <code><li></code> 要素を含みます。</li>\n <li>最上位の GFM <code><li></code> 要素は、最後の要素として GFM <code><ul></code> 要素を含みます。</li>\n <li>最終的に含まれる <code><ul></code> は、単一の GFM <code><li></code> 要素を含み、この中身は \": \" (コロンに続いて空白) で始まるテキストでなければなりません。この要素はブロック要素、例えば段落、コードブロック、埋め込みリスト、メモなどを含むことができます。</li>\n</ul>\n<p>最上位の GFM <code><li></code> 要素は、次のように <code><dt></code>/<code><dd></code> の組に変換されます。</p>\n<ul>\n <li>最上位の GFM <code><li></code> 要素は、GFM <code><li></code> 要素として解析され、その内部コンテンツは、 <code><dt></code> の内容を構成しますが、最後に入れ子になった <code><ul></code> については例外で、 <code><dt></code> には含まれません。</li>\n <li>最後に入れ子になった <code><ul></code> の中の <code><li></code> 要素は、GFM <code><li></code> 要素として解析され、その内容は <code><dd></code> の内容を構成しますが、先頭の <code>:</code> は捨てられます。</li>\n</ul>\n<p>例えば、これは <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 複数の段落やコードブロックを格納することもできます。\n\n ```js\n const thing = 1;\n ```\n</code></pre></div>\n<p>GFM/CommonMark では、これは次の 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>MDN では、これは次の 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>この構文で書かれた定義リストは、 <code><dt></code>/<code><dd></code> 要素のペアで構成されます。この構文では、 2 つ以上の連続した <code><dt></code> 要素、または 2 つ以上の連続した <code><dd></code> 要素を持つリストを書くことはできません。パーサーはこれをエラーとして扱います。 MDN 上のほとんどすべての定義リストがこの制限で動作することを期待しており、動作しないものについては、生の HTML に戻ることができます。</p>\n<p>以下のものは許可されていません。</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>複数の <code><dt></code> 項目を 1 つの <code><dd></code> に関連付ける必要がある場合の回避策として、以下のように複数の用語をカンマで区切って 1 つの <code><dt></code> として提供することを検討してください。</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>ここで説明する構文の根拠は、 CommonMark を期待するツール (Prettier や GitHub のプレビューなど) で十分に機能すると同時に、記述と解析が適度に簡単であることです。</p>"}},{"type":"prose","value":{"id":"議論リファレンス_3","title":"議論リファレンス","isH3":true,"content":"<p>この課題は <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":"表","title":"表","isH3":false,"content":"<p>GFM は<a href=\"https://github.github.com/gfm/#tables-extension-\" class=\"external\" target=\"_blank\">表</a>を作成する構文を提供しており、 MDN ではそれを使用しています。しかし、 GFM の表が私たちのニーズに合わない場合もあります。</p>\n<ul>\n <li>GFM の構文は HTML で利用可能な機能の一部しか対応していません。 GFM で対応していない表の機能を使う必要がある場合は、表を表現するのに HTML を使用してください。</li>\n <li>GFM による表の表現が幅 150 文字を超える場合は、 HTML の表を使用してください。</li>\n <li>「プロパティ表」と呼ばれる特殊な種類の表があり、独自の CSS クラスがあります。その場合は常に HTML を使用してください。</li>\n</ul>\n<p>ですから、ここでの一般的な原則は、可能な限り GFM Markdown の構文を使用しますが、 HTML を使用する必要がある場合、その方が読みやすい場合は生の HTML に立ち戻ってください。下記の <a href=\"#html_%E8%A1%A8%E3%82%92%E4%BD%BF%E7%94%A8%E3%81%99%E3%82%8B%E5%A0%B4%E5%90%88\">HTML 表を使用する場合</a>を参照してください。</p>"}},{"type":"prose","value":{"id":"gfm_の表の構文","title":"GFM の表の構文","isH3":true,"content":"<p>GFM の表構文では、行の先頭と末尾のパイプを省略できます。しかし、 MDN では読み取り可能なように、これらのパイプを記載しなければなりません。また、行の末尾に空間を提供し、段組みのセルがすべて同じ長さになるようにしなければなりません。</p>\n<p>つまり、 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>| 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>このスタイルではありません。</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>幸いなことに、表の書式は Prettier によって自動修正されるので、書き手は Prettier に頼って表を適切に整形することができます。</p>"}},{"type":"prose","value":{"id":"html_表を使用する場合","title":"HTML 表を使用する場合","isH3":true,"content":"<p>書き手が GFM 構文ではなく HTML 表を使用すべき主な状況は 3 つあります。</p>\n<ol>\n <li>表は GFM では対応していない機能（下記参照）を使用する場合。</li>\n <li>GFM お表の幅が広すぎて読みにくい場合。</li>\n <li>書き手が「プロパティテーブル」と呼ばれる特殊な表を使いたい場合。</li>\n</ol>\n<h4 id=\"gfm_が対応していない表機能\">GFM が対応していない表機能</h4>\n<p>GFM 表構文の主な制限事項は以下の通りです。</p>\n<ul>\n <li>GFM の表ではヘッダー行が必要です。</li>\n <li>GFM の表ではヘッダー列を設定することができません。</li>\n <li>GFM は表のセル内にある GFM ブロック要素を解析しません。例えば、表のセル内にリストを入れることはできません。</li>\n <li>GFM の表にはクラスを割り当てることはできません。</li>\n <li>GFM は <code><table></code>, <code><tr></code>, <code><th></code>, <code><td></code> 以外の表要素に対応していません。</li>\n <li>GFM は <code>colspan</code>, <code>rowspan</code>, <code>scope</code> のような表要素の属性に対応していません。</li>\n</ul>\n<p>もし、対応していない機能を使う必要がある場合は、 HTML で表を作成する必要があります。</p>\n<p>なお、表に <code><caption></code> 要素を使うことは、 GFM 構文からも排除されるため、一般的にはお勧めしません。</p>\n<h4 id=\"gfm_表の最大幅\">GFM 表の最大幅</h4>\n<p>GFM では、表を「<a href=\"/ja/docs/Glossary/ASCII\">ASCII</a> アート」で表現しているため、表が長くなると読みづらくなります。たとえば、次のような表があるとします。</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>見出し 1</th>\n <th>見出し 2</th>\n <th>見出し 3</th>\n <th>見出し 4</th>\n <th>見出し 5</th>\n <th>見出し 6</th>\n </tr>\n <tr>\n <td>短めのもの</td>\n <td>\n GFM の書式では表組みが崩れてしまうほど、何かについて本当に詳しく書かれている長いもの。\n </td>\n <td>短めのもの</td>\n <td>\n また、何かについて実に詳しく書かれている、大量のテキストを含むセルは、 GFM の書式では表の書式が崩れ始めてしまいます。\n </td>\n <td>短めのもの</td>\n <td>短めのもの</td>\n </tr>\n</table>\n</code></pre></div>\n<p>GFM ではこのようになります。</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>| 見出し 1 | 見出し 2 | 見出し 3 | 見出し 4 | 見出し 5 | 見出し 6 |\n| ---------- | -------------------------------------------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | ---------- |\n| 短めのもの | GFM の書式では表組みが崩れてしまうほど、何かについて本当に詳しく書かれている長いもの。 | 短めのもの | また、何かについて実に詳しく書かれている、大量のテキストを含むセルは、 GFM の書式では表の書式が崩れ始めてしまいます。 | 短めのもの | 短めのもの |\n</code></pre></div>\n<p>このような場合は、HTML を使用するのがよいでしょう。</p>\n<p>これにより導かれるガイドラインは、表の Markdown 表現が幅 150 文字以上になる場合、その表には HTML を使用することです。</p>\n<h4 id=\"プロパティ表\">プロパティ表</h4>\n<p>プロパティ表は特定の種類の表で、特定の型のページ同士でまたがって使用される、構造化されたプロパティ値を表示するために使用されるものです。これらの表には 2 つの列があります。最初の列はヘッダー列で、プロパティを列挙し、2 番目の列にはこの特定の項目に関する値を列挙します。例えば、以下は <a href=\"/ja/docs/Web/API/PannerNode\"><code>PannerNode</code></a> インターフェイスのプロパティ表です。</p>\n<figure class=\"table-container\"><table class=\"properties\">\n <tbody>\n <tr>\n <th scope=\"row\">入力数</th>\n <td><code>1</code></td>\n </tr>\n <tr>\n <th scope=\"row\">出力数</th>\n <td><code>0</code></td>\n </tr>\n <tr>\n <th scope=\"row\">チャンネルの数え方</th>\n <td><code>\"explicit\"</code></td>\n </tr>\n <tr>\n <th scope=\"row\">チャンネル数</th>\n <td><code>2</code></td>\n </tr>\n <tr>\n <th scope=\"row\">チャンネルの意味</th>\n <td><code>\"speakers\"</code></td>\n </tr>\n </tbody>\n</table></figure>\n<p>\n これらのページはヘッダー列があるため、 GFM では表せませんので、この場合は HTML を使用しましょう。\n 特殊なスタイルにするには、 <code>\"properties\"</code> クラスを表に適用する必要があります。\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":"議論リファレンス_4","title":"議論リファレンス","isH3":true,"content":"<p>この課題は <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>, <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":"上付き・下付き文字","title":"上付き・下付き文字","isH3":false,"content":"<p>HTML の <a href=\"/ja/docs/Web/HTML/Element/sup\"><code><sup></code></a> および <a href=\"/ja/docs/Web/HTML/Element/sub\"><code><sub></code></a> 要素を必要に応じて使用することができますが、可能な限り代替策を採ってください。具体的には次のようにします。</p>\n<ul>\n <li>べき乗については、 <code>2^53</code> のようにキャレットを使用してください。</li>\n <li>1<sup>st</sup> のような序数表現では、 \"first\" のように言葉を使用してください。</li>\n <li>脚注については、脚注参照を <code><sup>[1]</sup></code> のようにマークアップしないでください。必要ありません。</li>\n</ul>"}},{"type":"prose","value":{"id":"議論リファレンス_5","title":"議論リファレンス","isH3":true,"content":"<p>この課題は <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":"ページ概要","title":"ページ概要","isH3":false,"content":"<p>ページ概要はページの最初の「コンテンツ」の段落で、ページのフロントマターや<a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Macros/Commonly_used_macros#%E3%82%B5%E3%82%A4%E3%83%89%E3%83%90%E3%83%BC%E3%81%AE%E7%94%9F%E6%88%90\">サイドバー</a>や<a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Macros/Commonly_used_macros#%E3%83%9A%E3%83%BC%E3%82%B8%E3%81%BE%E3%81%9F%E3%81%AF%E3%82%BB%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%AE%E3%83%98%E3%83%83%E3%83%80%E3%83%BC%E3%82%92%E7%A4%BA%E3%81%99%E3%82%A4%E3%83%B3%E3%82%B8%E3%82%B1%E3%83%BC%E3%82%BF%E3%83%BC\">ページバナー</a>マクロの後に現れる最初のテキストです。</p>\n<p>\n この概要は検索エンジン最適化 (SEO) のために使用され、また、マクロによってはページリストに自動的に含まれます。\n したがって、最初の段落は、簡潔で説明的なものでなければなりません。\n</p>"}},{"type":"prose","value":{"id":"議論リファレンス_6","title":"議論リファレンス","isH3":true,"content":"<p>この課題は <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>文章のコンテンツに、 KumaScript のマクロ呼び出しを含めることができます。</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">md</span></div><pre class=\"brush: md notranslate\"><code>**`margin`** は [CSS](/ja/docs/Web/CSS) のプロパティで、要素の全 4 辺のマージン領域を設定します。\nこれは {{cssxref(\"margin-top\")}}, {{cssxref(\"margin-right\")}}, {{cssxref(\"margin-bottom\")}}, {{cssxref(\"margin-left\")}} の一括指定です。\n\n{{EmbedInteractiveExample(\"pages/css/margin.html\")}}\n\n上下のマージンは置換インライン要素、例えば {{HTMLElement(\"span\")}} や {{HTMLElement(\"code\")}} では効果がありません。\n</code></pre></div>\n<p>マクロについてのより詳しい情報は、<a href=\"/ja/docs/MDN/Writing_guidelines/Page_structures/Macros\">マクロの使用</a>を参照してください。</p>"}}],"toc":[{"text":"ベースライン: GitHub-Flavored Markdown","id":"ベースライン_github-flavored_markdown"},{"text":"リンク","id":"リンク"},{"text":"コードブロックの例","id":"コードブロックの例"},{"text":"メモ、警告、コールアウト","id":"メモ、警告、コールアウト"},{"text":"定義リスト","id":"定義リスト"},{"text":"表","id":"表"},{"text":"上付き・下付き文字","id":"上付き・下付き文字"},{"text":"ページ概要","id":"ページ概要"},{"text":"KumaScript","id":"kumascript"}],"summary":"このページでは、 Markdown を使用してどのように MDN Web Docs のドキュメントを書くかを説明します。ベースラインとして GitHub-Flavored Markdown (GFM) を選択し、 GFM では容易にサポートされていない MDN で行う必要のあるいくつかのことに対応するために、いくつかの拡張機能を追加しました。","popularity":0,"modified":"2024-07-28T08:23:52.000Z","other_translations":[{"locale":"de","title":"Anleitung zur Verwendung von Markdown","native":"Deutsch"},{"locale":"en-US","title":"How to write in Markdown","native":"English (US)"},{"locale":"es","title":"Cómo escribir en Markdown","native":"Español"},{"locale":"fr","title":"Comment écrire du Markdown","native":"Français"},{"locale":"pt-BR","title":"Como escrever em Markdown","native":"Português (do Brasil)"},{"locale":"zh-CN","title":"如何使用 Markdown 来撰写文档","native":"中文 (简体)"}],"pageType":"unknown","source":{"folder":"ja/mdn/writing_guidelines/howto/markdown_in_mdn","github_url":"https://github.com/mdn/translated-content/blob/main/files/ja/mdn/writing_guidelines/howto/markdown_in_mdn/index.md","last_commit_url":"https://github.com/mdn/translated-content/commit/10c079c862b80d3fe62f49a1b0e92c2329cad4bd","filename":"index.md"},"short_title":"Markdown の書き方","parents":[{"uri":"/ja/docs/MDN","title":"MDN Web Docs プロジェクト"},{"uri":"/ja/docs/MDN/Writing_guidelines","title":"執筆ガイドライン"},{"uri":"/ja/docs/MDN/Writing_guidelines/Howto","title":"How-to ガイド"},{"uri":"/ja/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN","title":"Markdown の書き方"}],"pageTitle":"Markdown の書き方 - MDN Web Docs プロジェクト | MDN","noIndexing":false}}</script></body></html>