CINXE.COM

<!doctype html><html lang="en-US" prefix="og: https://ogp.me/ns#"><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><link rel="icon" href="https://developer.mozilla.org/favicon-48x48.bc390275e955dacb2e65.png"/><link rel="apple-touch-icon" href="https://developer.mozilla.org/apple-touch-icon.528534bba673c38049c2.png"/><meta name="theme-color" content="#ffffff"/><link rel="manifest" href="https://developer.mozilla.org/manifest.f42880861b394dd4dc9b.json"/><link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="MDN Web Docs"/><title>How to use structured data - MDN Web Docs | MDN</title><link rel="alternate" title="Anleitung zur Verwendung strukturierter Daten" href="https://developer.mozilla.org/de/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data" hrefLang="de"/><link rel="alternate" title="Cómo usar datos estructurados" href="https://developer.mozilla.org/es/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data" hrefLang="es"/><link rel="alternate" title="構造化データの使用方法" href="https://developer.mozilla.org/ja/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data" hrefLang="ja"/><link rel="alternate" title="如何使用结构化数据" href="https://developer.mozilla.org/zh-CN/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data" hrefLang="zh"/><link rel="alternate" title="How to use structured data" href="https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data" hrefLang="en"/><link rel="preload" as="font" type="font/woff2" href="/static/media/Inter.var.c2fe3cb2b7c746f7966a.woff2" crossorigin=""/><link rel="alternate" type="application/rss+xml" title="MDN Blog RSS Feed" href="https://developer.mozilla.org/en-US/blog/rss.xml" hrefLang="en"/><meta name="description" content="MDN stores data in well-defined structures when possible. This information is then centralized and can be updated once, while being used in numerous places."/><meta property="og:url" content="https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data"/><meta property="og:title" content="How to use structured data - MDN Web Docs | MDN"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:description" content="MDN stores data in well-defined structures when possible. This information is then centralized and can be updated once, while being used in numerous places."/><meta property="og:image" content="https://developer.mozilla.org/mdn-social-share.d893525a4fb5fb1f67a2.png"/><meta property="og:image:type" content="image/png"/><meta property="og:image:height" content="1080"/><meta property="og:image:width" content="1920"/><meta property="og:image:alt" content="The MDN Web Docs logo, featuring a blue accent color, displayed on a solid black background."/><meta property="og:site_name" content="MDN Web Docs"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:creator" content="MozDevNet"/><link rel="canonical" href="https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data"/><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.f565372a.js"></script><link href="/static/css/main.3d9e7a02.css" rel="stylesheet"/></head><body><script>if(document.body.addEventListener("load",(t=>{t.target.classList.contains("interactive")&&t.target.setAttribute("data-readystate","complete")}),{capture:!0}),window&&document.documentElement){const t={light:"#ffffff",dark:"#1b1b1b"};try{const e=window.localStorage.getItem("theme");e&&(document.documentElement.className=e,document.documentElement.style.backgroundColor=t[e]);const o=window.localStorage.getItem("nop");o&&(document.documentElement.dataset.nop=o)}catch(t){console.warn("Unable to read theme from localStorage",t)}}</script><div id="root"><ul id="nav-access" class="a11y-nav"><li><a id="skip-main" href="#content">Skip to main content</a></li><li><a id="skip-search" href="#top-nav-search-input">Skip to search</a></li><li><a id="skip-select-language" href="#languages-switcher-button">Skip to select language</a></li></ul><div class="page-wrapper document-page"><div class="top-banner loading"><section class="place top container"></section></div><div class="sticky-header-container"><header class="top-navigation "><div class="container "><div class="top-navigation-wrap"><a href="/en-US/" class="logo" aria-label="MDN homepage"><svg id="mdn-docs-logo" xmlns="http://www.w3.org/2000/svg" x="0" y="0" viewBox="0 0 694.9 104.4" style="enable-background:new 0 0 694.9 104.4" xml:space="preserve" role="img"><title>MDN Web Docs</title><path d="M40.3 0 11.7 92.1H0L28.5 0h11.8zm10.4 0v92.1H40.3V0h10.4zM91 0 62.5 92.1H50.8L79.3 0H91zm10.4 0v92.1H91V0h10.4z" class="logo-m"></path><path d="M627.9 95.6h67v8.8h-67v-8.8z" class="logo-_"></path><path d="M367 42h-4l-10.7 30.8h-5.5l-10.8-26h-.4l-10.5 26h-5.2L308.7 42h-3.8v-5.6H323V42h-6.5l6.8 20.4h.4l10.3-26h4.7l11.2 26h.5l5.7-20.3h-6.2v-5.6H367V42zm34.9 20c-.4 3.2-2 5.9-4.7 8.2-2.8 2.3-6.5 3.4-11.3 3.4-5.4 0-9.7-1.6-13.1-4.7-3.3-3.2-5-7.7-5-13.7 0-5.7 1.6-10.3 4.7-14s7.4-5.5 12.9-5.5c5.1 0 9.1 1.6 11.9 4.7s4.3 6.9 4.3 11.3c0 1.5-.2 3-.5 4.7h-25.6c.3 7.7 4 11.6 10.9 11.6 2.9 0 5.1-.7 6.5-2 1.5-1.4 2.5-3 3-4.9l6 .9zM394 51.3c.2-2.4-.4-4.7-1.8-6.9s-3.8-3.3-7-3.3c-3.1 0-5.3 1-6.9 3-1.5 2-2.5 4.4-2.8 7.2H394zm51 2.4c0 5-1.3 9.5-4 13.7s-6.9 6.2-12.7 6.2c-6 0-10.3-2.2-12.7-6.7-.1.4-.2 1.4-.4 2.9s-.3 2.5-.4 2.9h-7.3c.3-1.7.6-3.5.8-5.3.3-1.8.4-3.7.4-5.5V22.3h-6v-5.6H416v27c1.1-2.2 2.7-4.1 4.7-5.7 2-1.6 4.8-2.4 8.4-2.4 4.6 0 8.4 1.6 11.4 4.7 3 3.2 4.5 7.6 4.5 13.4zm-7.7.6c0-4.2-1-7.4-3-9.5-2-2.2-4.4-3.3-7.4-3.3-3.4 0-6 1.2-8 3.7-1.9 2.4-2.9 5-3 7.7V57c0 3 1 5.6 3 7.7s4.5 3.1 7.6 3.1c3.6 0 6.3-1.3 8.1-3.9 1.8-2.7 2.7-5.9 2.7-9.6zm69.2 18.5h-13.2v-7.2c-1.2 2.2-2.8 4.1-4.9 5.6-2.1 1.6-4.8 2.4-8.3 2.4-4.8 0-8.7-1.6-11.6-4.9-2.9-3.2-4.3-7.7-4.3-13.3 0-5 1.3-9.6 4-13.7 2.6-4.1 6.9-6.2 12.8-6.2 5.7 0 9.8 2.2 12.3 6.5V22.3h-8.6v-5.6h15.8v50.6h6v5.5zM493.2 56v-4.4c-.1-3-1.2-5.5-3.2-7.3s-4.4-2.8-7.2-2.8c-3.6 0-6.3 1.3-8.2 3.9-1.9 2.6-2.8 5.8-2.8 9.6 0 4.1 1 7.3 3 9.5s4.5 3.3 7.4 3.3c3.2 0 5.8-1.3 7.8-3.8 2.1-2.6 3.1-5.3 3.2-8zm53.1-1.4c0 5.6-1.8 10.2-5.3 13.7s-8.2 5.3-13.9 5.3-10.1-1.7-13.4-5.1c-3.3-3.4-5-7.9-5-13.5 0-5.3 1.6-9.9 4.7-13.7 3.2-3.8 7.9-5.7 14.2-5.7s11 1.9 14.1 5.7c3 3.7 4.6 8.1 4.6 13.3zm-7.7-.2c0-4-1-7.2-3-9.5s-4.8-3.5-8.2-3.5c-3.6 0-6.4 1.2-8.3 3.7s-2.9 5.6-2.9 9.5c0 3.7.9 6.8 2.8 9.4 1.9 2.6 4.6 3.9 8.3 3.9 3.6 0 6.4-1.3 8.4-3.8 1.9-2.6 2.9-5.8 2.9-9.7zm45 5.8c-.4 3.2-1.9 6.3-4.4 9.1-2.5 2.9-6.4 4.3-11.8 4.3-5.2 0-9.4-1.6-12.6-4.8-3.2-3.2-4.8-7.7-4.8-13.7 0-5.5 1.6-10.1 4.7-13.9 3.2-3.8 7.6-5.7 13.2-5.7 2.3 0 4.6.3 6.7.8 2.2.5 4.2 1.5 6.2 2.9l1.5 9.5-5.9.7-1.3-6.1c-2.1-1.2-4.5-1.8-7.2-1.8-3.5 0-6.1 1.2-7.7 3.7-1.7 2.5-2.5 5.7-2.5 9.6 0 4.1.9 7.3 2.7 9.5 1.8 2.3 4.4 3.4 7.8 3.4 5.2 0 8.2-2.9 9.2-8.8l6.2 1.3zm34.7 1.9c0 3.6-1.5 6.5-4.6 8.5s-7 3-11.7 3c-5.7 0-10.6-1.2-14.6-3.6l1.2-8.8 5.7.6-.2 4.7c1.1.5 2.3.9 3.6 1.1s2.6.3 3.9.3c2.4 0 4.5-.4 6.5-1.3 1.9-.9 2.9-2.2 2.9-4.1 0-1.8-.8-3.1-2.3-3.8s-3.5-1.3-5.8-1.7-4.6-.9-6.9-1.4c-2.3-.6-4.2-1.6-5.7-2.9-1.6-1.4-2.3-3.5-2.3-6.3 0-4.1 1.5-6.9 4.6-8.5s6.4-2.4 9.9-2.4c2.6 0 5 .3 7.2.9 2.2.6 4.3 1.4 6.1 2.4l.8 8.8-5.8.7-.8-5.7c-2.3-1-4.7-1.6-7.2-1.6-2.1 0-3.7.4-5.1 1.1-1.3.8-2 2-2 3.8 0 1.7.8 2.9 2.3 3.6 1.5.7 3.4 1.2 5.7 1.6 2.2.4 4.5.8 6.7 1.4 2.2.6 4.1 1.6 5.7 3 1.4 1.6 2.2 3.7 2.2 6.6zM197.6 73.2h-17.1v-5.5h3.8V51.9c0-3.7-.7-6.3-2.1-7.9-1.4-1.6-3.3-2.3-5.7-2.3-3.2 0-5.6 1.1-7.2 3.4s-2.4 4.6-2.5 6.9v15.6h6v5.5h-17.1v-5.5h3.8V51.9c0-3.8-.7-6.4-2.1-7.9-1.4-1.5-3.3-2.3-5.6-2.3-3.2 0-5.5 1.1-7.2 3.3-1.6 2.2-2.4 4.5-2.5 6.9v15.8h6.9v5.5h-20.2v-5.5h6V42.4h-6.1v-5.6h13.4v6.4c1.2-2.1 2.7-3.8 4.7-5.2 2-1.3 4.4-2 7.3-2s5.3.7 7.5 2.1c2.2 1.4 3.7 3.5 4.5 6.4 1.1-2.5 2.7-4.5 4.9-6.1s4.8-2.4 7.9-2.4c3.5 0 6.5 1.1 8.9 3.3s3.7 5.6 3.7 10.2v18.2h6.1v5.5zm42.5 0h-13.2V66c-1.2 2.2-2.8 4.1-4.9 5.6-2.1 1.6-4.8 2.4-8.3 2.4-4.8 0-8.7-1.6-11.6-4.9-2.9-3.2-4.3-7.7-4.3-13.3 0-5 1.3-9.6 4-13.7 2.6-4.1 6.9-6.2 12.8-6.2s9.8 2.2 12.3 6.5V22.7h-8.6v-5.6h15.8v50.6h6v5.5zm-13.3-16.8V52c-.1-3-1.2-5.5-3.2-7.3s-4.4-2.8-7.2-2.8c-3.6 0-6.3 1.3-8.2 3.9-1.9 2.6-2.8 5.8-2.8 9.6 0 4.1 1 7.3 3 9.5s4.5 3.3 7.4 3.3c3.2 0 5.8-1.3 7.8-3.8 2.1-2.6 3.1-5.3 3.2-8zm61.5 16.8H269v-5.5h6V51.9c0-3.7-.7-6.3-2.2-7.9-1.4-1.6-3.4-2.3-5.7-2.3-3.1 0-5.6 1-7.4 3s-2.8 4.4-2.9 7v15.9h6v5.5h-19.3v-5.5h6V42.4h-6.2v-5.6h13.6V43c2.6-4.6 6.8-6.9 12.7-6.9 3.6 0 6.7 1.1 9.2 3.3s3.7 5.6 3.7 10.2v18.2h6v5.4h-.2z" class="logo-text"></path></svg></a><button title="Open main menu" type="button" class="button action has-icon main-menu-toggle" aria-haspopup="menu" aria-label="Open main menu" aria-expanded="false"><span class="button-wrap"><span class="icon icon-menu "></span><span class="visually-hidden">Open main menu</span></span></button></div><div class="top-navigation-main"><nav class="main-nav" aria-label="Main menu"><ul class="main-menu nojs"><li class="top-level-entry-container "><button type="button" id="references-button" class="top-level-entry menu-toggle" aria-controls="references-menu" aria-expanded="false">References</button><a href="/en-US/docs/Web" class="top-level-entry">References</a><ul id="references-menu" class="submenu references hidden inline-submenu-lg" aria-labelledby="references-button"><li class="apis-link-container mobile-only "><a href="/en-US/docs/Web" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview / Web Technology</div><p class="submenu-item-description">Web technology reference for developers</p></div></a></li><li class="html-link-container "><a href="/en-US/docs/Web/HTML" class="submenu-item "><div class="submenu-icon html"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTML</div><p class="submenu-item-description">Structure of content on the web</p></div></a></li><li class="css-link-container "><a href="/en-US/docs/Web/CSS" class="submenu-item "><div class="submenu-icon css"></div><div class="submenu-content-container"><div class="submenu-item-heading">CSS</div><p class="submenu-item-description">Code used to describe document style</p></div></a></li><li class="javascript-link-container "><a href="/en-US/docs/Web/JavaScript" class="submenu-item "><div class="submenu-icon javascript"></div><div class="submenu-content-container"><div class="submenu-item-heading">JavaScript</div><p class="submenu-item-description">General-purpose scripting language</p></div></a></li><li class="http-link-container "><a href="/en-US/docs/Web/HTTP" class="submenu-item "><div class="submenu-icon http"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTTP</div><p class="submenu-item-description">Protocol for transmitting web resources</p></div></a></li><li class="apis-link-container "><a href="/en-US/docs/Web/API" class="submenu-item "><div class="submenu-icon apis"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web APIs</div><p class="submenu-item-description">Interfaces for building web applications</p></div></a></li><li class="apis-link-container "><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web Extensions</div><p class="submenu-item-description">Developing extensions for web browsers</p></div></a></li><li class=" "><a href="/en-US/docs/Web/Accessibility" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Accessibility</div><p class="submenu-item-description">Build web projects usable for all</p></div></a></li><li class="apis-link-container desktop-only "><a href="/en-US/docs/Web" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Web Technology</div><p class="submenu-item-description">Web technology reference for developers</p></div></a></li></ul></li><li class="top-level-entry-container "><button type="button" id="learn-button" class="top-level-entry menu-toggle" aria-controls="learn-menu" aria-expanded="false">Learn</button><a href="/en-US/docs/Learn_web_development" class="top-level-entry">Learn</a><ul id="learn-menu" class="submenu learn hidden inline-submenu-lg" aria-labelledby="learn-button"><li class="apis-link-container mobile-only "><a href="/en-US/docs/Learn_web_development" class="submenu-item "><div class="submenu-icon learn"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview / MDN Learning Area</div><p class="submenu-item-description">Learn web development</p></div></a></li><li class="apis-link-container desktop-only "><a href="/en-US/docs/Learn_web_development" class="submenu-item "><div class="submenu-icon learn"></div><div class="submenu-content-container"><div class="submenu-item-heading">MDN Learning Area</div><p class="submenu-item-description">Learn web development</p></div></a></li><li class="html-link-container "><a href="/en-US/docs/Learn_web_development/Core/Structuring_content" class="submenu-item "><div class="submenu-icon html"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTML</div><p class="submenu-item-description">Learn to structure web content with HTML</p></div></a></li><li class="css-link-container "><a href="/en-US/docs/Learn_web_development/Core/Styling_basics" class="submenu-item "><div class="submenu-icon css"></div><div class="submenu-content-container"><div class="submenu-item-heading">CSS</div><p class="submenu-item-description">Learn to style content using CSS</p></div></a></li><li class="javascript-link-container "><a href="/en-US/docs/Learn_web_development/Core/Scripting" class="submenu-item "><div class="submenu-icon javascript"></div><div class="submenu-content-container"><div class="submenu-item-heading">JavaScript</div><p class="submenu-item-description">Learn to run scripts in the browser</p></div></a></li><li class=" "><a href="/en-US/docs/Learn_web_development/Core/Accessibility" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Accessibility</div><p class="submenu-item-description">Learn to make the web accessible to all</p></div></a></li></ul></li><li class="top-level-entry-container "><button type="button" id="mdn-plus-button" class="top-level-entry menu-toggle" aria-controls="mdn-plus-menu" aria-expanded="false">Plus</button><a href="/en-US/plus" class="top-level-entry">Plus</a><ul id="mdn-plus-menu" class="submenu mdn-plus hidden inline-submenu-lg" aria-labelledby="mdn-plus-button"><li class=" "><a href="/en-US/plus" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Overview</div><p class="submenu-item-description">A customized MDN experience</p></div></a></li><li class=" "><a href="/en-US/plus/ai-help" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">AI Help</div><p class="submenu-item-description">Get real-time assistance and support</p></div></a></li><li class=" "><a href="/en-US/plus/updates" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Updates</div><p class="submenu-item-description">All browser compatibility updates at a glance</p></div></a></li><li class=" "><a href="/en-US/plus/docs/features/overview" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Documentation</div><p class="submenu-item-description">Learn how to use MDN Plus</p></div></a></li><li class=" "><a href="/en-US/plus/docs/faq" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">FAQ</div><p class="submenu-item-description">Frequently asked questions about MDN Plus</p></div></a></li></ul></li><li class="top-level-entry-container "><a class="top-level-entry menu-link" href="/en-US/curriculum/">Curriculum <sup class="new">New</sup></a></li><li class="top-level-entry-container "><a class="top-level-entry menu-link" href="/en-US/blog/">Blog</a></li><li class="top-level-entry-container "><button type="button" id="tools-button" class="top-level-entry menu-toggle" aria-controls="tools-menu" aria-expanded="false">Tools</button><ul id="tools-menu" class="submenu tools hidden inline-submenu-lg" aria-labelledby="tools-button"><li class=" "><a href="/en-US/play" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">Playground</div><p class="submenu-item-description">Write, test and share your code</p></div></a></li><li class=" "><a href="/en-US/observatory" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">HTTP Observatory</div><p class="submenu-item-description">Scan a website for free</p></div></a></li><li class=" "><a href="/en-US/plus/ai-help" class="submenu-item "><div class="submenu-icon"></div><div class="submenu-content-container"><div class="submenu-item-heading">AI Help</div><p class="submenu-item-description">Get real-time assistance and support</p></div></a></li></ul></li></ul></nav><div class="header-search"><form action="/en-US/search" class="search-form search-widget" id="top-nav-search-form" role="search"><label id="top-nav-search-label" for="top-nav-search-input" class="visually-hidden">Search MDN</label><input aria-activedescendant="" aria-autocomplete="list" aria-controls="top-nav-search-menu" aria-expanded="false" aria-labelledby="top-nav-search-label" autoComplete="off" id="top-nav-search-input" role="combobox" type="search" class="search-input-field" name="q" placeholder=" " required="" value=""/><button type="button" class="button action has-icon clear-search-button"><span class="button-wrap"><span class="icon icon-cancel "></span><span class="visually-hidden">Clear search input</span></span></button><button type="submit" class="button action has-icon search-button"><span class="button-wrap"><span class="icon icon-search "></span><span class="visually-hidden">Search</span></span></button><div id="top-nav-search-menu" role="listbox" aria-labelledby="top-nav-search-label"></div></form></div><div class="theme-switcher-menu"><button type="button" class="button action has-icon theme-switcher-menu small" aria-haspopup="menu"><span class="button-wrap"><span class="icon icon-theme-os-default "></span>Theme</span></button></div><ul class="auth-container"><li><a href="/users/fxa/login/authenticate/?next=%2Fen-US%2Fdocs%2FMDN%2FWriting_guidelines%2FHowto%2FJSON_Structured_data" class="login-link" rel="nofollow">Log in</a></li><li><a href="/users/fxa/login/authenticate/?next=%2Fen-US%2Fdocs%2FMDN%2FWriting_guidelines%2FHowto%2FJSON_Structured_data" target="_self" rel="nofollow" class="button primary mdn-plus-subscribe-link"><span class="button-wrap">Sign up for free</span></a></li></ul></div></div></header><div class="article-actions-container"><div class="container"><button type="button" class="button action has-icon sidebar-button" aria-label="Expand sidebar" aria-expanded="false" aria-controls="sidebar-quicklinks"><span class="button-wrap"><span class="icon icon-sidebar "></span></span></button><nav class="breadcrumbs-container" aria-label="Breadcrumb"><ol typeof="BreadcrumbList" vocab="https://schema.org/" aria-label="breadcrumbs"><li property="itemListElement" typeof="ListItem"><a href="/en-US/docs/MDN" class="breadcrumb" property="item" typeof="WebPage"><span property="name">MDN Web Docs</span></a><meta property="position" content="1"/></li><li property="itemListElement" typeof="ListItem"><a href="/en-US/docs/MDN/Writing_guidelines" class="breadcrumb" property="item" typeof="WebPage"><span property="name">Writing guidelines</span></a><meta property="position" content="2"/></li><li property="itemListElement" typeof="ListItem"><a href="/en-US/docs/MDN/Writing_guidelines/Howto" class="breadcrumb" property="item" typeof="WebPage"><span property="name">How-to</span></a><meta property="position" content="3"/></li><li property="itemListElement" typeof="ListItem"><a href="/en-US/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data" class="breadcrumb-current-page" property="item" typeof="WebPage"><span property="name">Use structured data</span></a><meta property="position" content="4"/></li></ol></nav><div class="article-actions"><button type="button" class="button action has-icon article-actions-toggle" aria-label="Article actions"><span class="button-wrap"><span class="icon icon-ellipses "></span><span class="article-actions-dialog-heading">Article Actions</span></span></button><ul class="article-actions-entries"><li class="article-actions-entry"><div class="languages-switcher-menu open-on-focus-within"><button id="languages-switcher-button" type="button" class="button action small has-icon languages-switcher-menu" aria-haspopup="menu"><span class="button-wrap"><span class="icon icon-language "></span>English (US)</span></button><div class="hidden"><ul class="submenu language-menu " aria-labelledby="language-menu-button"><li class=" "><form class="submenu-item locale-redirect-setting"><div class="group"><label class="switch"><input type="checkbox" name="locale-redirect"/><span class="slider"></span><span class="label">Remember language</span></label><a href="https://github.com/orgs/mdn/discussions/739" rel="external noopener noreferrer" target="_blank" title="Enable this setting to automatically switch to this language when it's available. (Click to learn more.)"><span class="icon icon-question-mark "></span></a></div></form></li><li class=" "><a data-locale="de" href="/de/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data" class="button submenu-item"><span>Deutsch</span><span title="Diese Übersetzung ist Teil eines Experiments."><span class="icon icon-experimental "></span></span></a></li><li class=" "><a data-locale="es" href="/es/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data" class="button submenu-item"><span>Español</span></a></li><li class=" "><a data-locale="ja" href="/ja/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data" class="button submenu-item"><span>日本語</span></a></li><li class=" "><a data-locale="zh-CN" href="/zh-CN/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data" class="button submenu-item"><span>中文 (简体)</span></a></li></ul></div></div></li></ul></div></div></div></div><div class="main-wrapper"><div class="sidebar-container"><aside id="sidebar-quicklinks" class="sidebar" data-macro="mdnsidebar"><button type="button" class="button action backdrop" aria-label="Collapse sidebar"><span class="button-wrap"></span></button><nav aria-label="Related Topics" class="sidebar-inner"><header class="sidebar-actions"><section class="sidebar-filter-container"><div class="sidebar-filter "><label id="sidebar-filter-label" class="sidebar-filter-label" for="sidebar-filter-input"><span class="icon icon-filter"></span><span class="visually-hidden">Filter sidebar</span></label><input id="sidebar-filter-input" autoComplete="off" class="sidebar-filter-input-field false" type="text" placeholder="Filter" value=""/><button type="button" class="button action has-icon clear-sidebar-filter-button"><span class="button-wrap"><span class="icon icon-cancel "></span><span class="visually-hidden">Clear filter input</span></span></button></div></section></header><div class="sidebar-inner-nav"><div class="in-nav-toc"><div class="document-toc-container"><section class="document-toc"><header><h2 class="document-toc-heading">In this article</h2></header><ul class="document-toc-list"><li class="document-toc-item "><a class="document-toc-link" href="#groupdata_logical_grouping_of_apis">GroupData: logical grouping of APIs</a></li><li class="document-toc-item "><a class="document-toc-link" href="#interfacedata_recording_interface_inheritance">InterfaceData: recording interface inheritance</a></li><li class="document-toc-item "><a class="document-toc-link" href="#specdata_specification_information">SpecData: Specification information</a></li></ul></section></div></div><div class="sidebar-body"><ol><li class="section"><a href="/en-US/docs/MDN">MDN Web Docs</a></li><li><a href="/en-US/docs/MDN/Tutorials">Tutorials</a></li><li><a href="/en-US/docs/MDN/Guides">Guides</a></li><li class="toggle"><details><summary>Community resources</summary><ol><li><a href="/en-US/docs/MDN/Community">Resources</a></li><li><a href="/en-US/docs/MDN/Community/Getting_started">Getting started</a></li><li><a href="/en-US/docs/MDN/Community/Our_repositories">GitHub repositories</a></li><li><a href="/en-US/docs/MDN/Community/Open_source_etiquette">Open source etiquette</a></li><li><a href="/en-US/docs/MDN/Community/Issues">Creating and working on issues</a></li><li><a href="/en-US/docs/MDN/Community/Pull_requests">Pull request submission and reviews</a></li><li><a href="/en-US/docs/MDN/Community/Discussions">GitHub Discussions</a></li><li><a href="/en-US/docs/MDN/Community/Translated_content">Localization</a></li><li><a href="/en-US/docs/MDN/Community/Roles_teams">Roles and teams</a></li><li><a href="/en-US/docs/MDN/Community/Communication_channels">Communication channels</a></li><li><a href="/en-US/docs/MDN/Community/Learn_forum">Learn forum</a></li></ol></details></li><li class="toggle"><details open=""><summary>Writing guidelines</summary><ol><li><a href="/en-US/docs/MDN/Writing_guidelines">Writing guidelines</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/What_we_write">What we write</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Writing_style_guide">Style guide</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Learning_content">Learning content guidelines</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete">Experimental, deprecated, and obsolete</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Attrib_copyright_license">Attribution and copyright licensing</a></li><li class="toggle"><details open=""><summary>How-to guides</summary><ol><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto">Overview</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary">Add a glossary entry</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Images_media">Add media</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting">Create, edit, move, or delete pages</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Document_a_CSS_property">Document a CSS property</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Document_an_HTTP_header">Document an HTTP header</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Document_web_errors">Document errors</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Research_technology">Research a technology</a></li><li><em><a href="/en-US/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data" aria-current="page">Use structured data</a></em></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference">Write an API reference</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN">Write in Markdown</a></li></ol></details></li><li class="toggle"><details><summary>Page structures</summary><ol><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures">Overview</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Banners_and_notices">Banners and notices</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Code_examples">Code examples</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables">Compatibility tables and the browser compatibility data repository (BCD)</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Feature_status">Feature status</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Links">Link macros</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Live_samples">Live examples</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types">Page types</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Sidebars">Sidebars</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Specification_tables">Specification tables</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Syntax_sections">Syntax sections</a></li><li><a href="/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros">Using macros</a></li></ol></details></li></ol></details></li></ol></div></div><section class="place side"></section></nav></aside><div class="toc-container"><aside class="toc"><nav><div class="document-toc-container"><section class="document-toc"><header><h2 class="document-toc-heading">In this article</h2></header><ul class="document-toc-list"><li class="document-toc-item "><a class="document-toc-link" href="#groupdata_logical_grouping_of_apis">GroupData: logical grouping of APIs</a></li><li class="document-toc-item "><a class="document-toc-link" href="#interfacedata_recording_interface_inheritance">InterfaceData: recording interface inheritance</a></li><li class="document-toc-item "><a class="document-toc-link" href="#specdata_specification_information">SpecData: Specification information</a></li></ul></section></div></nav></aside><section class="place side"></section></div></div><main id="content" class="main-content "><article class="main-page-content" lang="en-US"><header><h1>How to use structured data</h1></header><div class="section-content"><p>MDN stores data in well-defined structures when possible. This information is then centralized and can be updated once, while being used in numerous places.</p> <p>There are several such files, and this document describes their purpose, structure, and maintenance process.</p></div><section aria-labelledby="groupdata_logical_grouping_of_apis"><h2 id="groupdata_logical_grouping_of_apis"><a href="#groupdata_logical_grouping_of_apis">GroupData: logical grouping of APIs</a></h2><div class="section-content"><p><code>GroupData</code> is a JSON file collecting information about Web APIs. The grouping of APIs is somewhat fuzzy: any interface, method or property can be part of several APIs. The set of APIs grouped under a name is a convention used to communicate about a feature, without any technical enforcement.</p> <p>Yet, MDN needs this information to create coherent Web-API sidebars (like with the <code>{{APIRef}}</code> macro) with the proper reference pages, guides, and overview articles.</p> <p>GroupData does exactly that: for each API, it lists the interfaces, properties, methods, guides, and overview pages. In the past, it also listed dictionaries and callbacks. But that use, though still supported, is deprecated and will be removed in the future.</p></div></section><section aria-labelledby="structure_of_groupdata"><h3 id="structure_of_groupdata"><a href="#structure_of_groupdata">Structure of GroupData</a></h3><div class="section-content"><div class="notecard warning"> <p><strong>Warning:</strong> Non-existent pages listed in this file are ignored (in en-US).</p> </div> <p>An entry in <code>GroupData.json</code> has the following structure:</p> <div class="code-example"><div class="example-header"><span class="language-name">json</span></div><pre class="brush: json notranslate"><code>"Name_of_the_API": { "overview": ["name_of_the_overview_page"], "guides": [ "name_of_guide_1", (…) ], "interfaces": [ "name_of_interface_1", (…) ], "methods": [ "name_of_additional_method_1", (…) ], "properties": [ "name_of_additional_property_1", (…) ], "events": [ "name_of_additional_property_1", (…) ] } </code></pre></div> <p>…where:</p> <dl> <dt id="name_of_the_api"><a href="#name_of_the_api"><code>"Name_of_the_API"</code></a></dt> <dd> <p>This key is both an ID used by sidebar macros like <code>{{APIRef("Name_of_the_API")}}</code> and the name displayed in the sidebar itself. Choose it wisely.</p> <div class="notecard warning"> <p><strong>Warning:</strong> If you want to change the name displayed in the sidebar, you must edit all the pages displaying it.</p> </div> </dd> <dt id="overview"><a href="#overview"><code>"overview"</code></a></dt> <dd> <p>This is a list containing one page: the overview page, used as the link for the <code>"Name_of_the_API"</code> text. The value is the <em>title of the page</em>, and the page must be in the <code>web/api/</code> directory.</p> </dd> <dt id="guides"><a href="#guides"><code>"guides"</code></a></dt> <dd> <p>This is a list of guides to display in the sidebar, in the given order. The values are <em>paths to the page</em>, starting with <code>/docs/</code>.</p> </dd> <dt id="interfaces"><a href="#interfaces"><code>"interfaces"</code></a></dt> <dd> <p>This lists the interfaces that are part of the API.</p> </dd> <dt id="methods"><a href="#methods"><code>"methods"</code></a></dt> <dd> <p>This lists the methods that are part of the API.</p> <div class="notecard note"> <p><strong>Note:</strong> The methods of the interfaces listed in <code>"interfaces"</code> <strong>must</strong> not be listed there. They are automatically added to the sidebar if the <code>page-type</code> key for that page is <code>web-api-static-method</code> or <code>web-api-instance-method</code>.</p> </div> </dd> <dt id="properties"><a href="#properties"><code>"properties"</code></a></dt> <dd> <p>This lists the properties on other interfaces that are part of the API, like <code>navigator.xr</code> (a property that the WebXR API adds to the <code>navigator</code> object)</p> <div class="notecard note"> <p><strong>Note:</strong> The properties of the interfaces listed in <code>"interfaces"</code> <strong>must</strong> not be listed there. They are automatically added to the sidebar if the <code>page-type</code> key for that page is <code>web-api-static-property</code> or <code>web-api-instance-property</code>.</p> </div> </dd> <dt id="events"><a href="#events"><code>"events"</code></a></dt> <dd> <p>This lists events of other interfaces that are part of the API. The values are the <em>title of the pages</em> (that must reside under <code>Web/Events</code>)</p> <div class="notecard note"> <p><strong>Note:</strong> The events targeting the interfaces listed in <code>"interfaces"</code> <strong>must</strong> not be listed there. They are automatically added to the sidebar if the <code>page-type</code> key for that page is <code>web-api-event</code>.</p> </div> </dd> </dl> <p>There are two other keys, <code>"dictionaries"</code> and <code>"callbacks"</code>, operating on the same principle. As we no longer document these entities in their own pages, their use is deprecated, and no new entry should be added to them (and we remove them little by little).</p> <div class="notecard note"> <p><strong>Note:</strong> Also, none of the keys are mandatory; it is good practice (and we'll enforce this) to add the non-deprecated ones with an empty list rather than omitting them. It shows that the absence of value is a conscious choice.</p> </div></div></section><section aria-labelledby="update_process_for_groupdata"><h3 id="update_process_for_groupdata"><a href="#update_process_for_groupdata">Update process for GroupData</a></h3><div class="section-content"><p>This file should be updated in the same PR where changes affecting the sidebar happens. That way, the sidebar is always up-to-date. Reviewers shouldn't merge PRs that don't adopt it.</p> <p>To test your changes, check that the sidebar in the files in your PR displays all entries correctly.</p> <p>The <code>GroupData.json</code> file is located <a href="https://github.com/mdn/content/blob/main/files/jsondata/GroupData.json" class="external" target="_blank">here</a> on GitHub.</p></div></section><section aria-labelledby="interfacedata_recording_interface_inheritance"><h2 id="interfacedata_recording_interface_inheritance"><a href="#interfacedata_recording_interface_inheritance">InterfaceData: recording interface inheritance</a></h2><div class="section-content"><div class="notecard note"> <p><strong>Note:</strong> We hope to generate this file automatically from the data available via w3c/webref in the future.</p> </div> <p><code>InterfaceData</code> describes the hierarchy of the interfaces. It lists inheritance. In the past, it also listed mixins implemented by each interface; but that usage is deprecated, and we remove mixins from this file at the same rate MDN is updated.</p> <p>This inheritance data is used when building API sidebars and by the <code>{{InheritanceDiagram}}</code> in the interface pages.</p></div></section><section aria-labelledby="structure_of_interfacedata"><h3 id="structure_of_interfacedata"><a href="#structure_of_interfacedata">Structure of InterfaceData</a></h3><div class="section-content"><p>An entry in <code>InterfaceData.json</code> has the following structure:</p> <div class="code-example"><div class="example-header"><span class="language-name">json</span></div><pre class="brush: json notranslate"><code>"Name_of_the_interface": { "inh": "Name_of_the_parent_interface", "impl": [] } </code></pre></div> <div class="notecard note"> <p><strong>Note:</strong> As mixins are deprecated, <code>"impl"</code> must be an empty list for all new interfaces.</p> </div> <p>The value of <code>"Name_of_the_parent_interface"</code> is not a list but a single entry, mandatory; we must not list any interface that don't inherit from another one.</p></div></section><section aria-labelledby="update_process_for_interfacedata"><h3 id="update_process_for_interfacedata"><a href="#update_process_for_interfacedata">Update process for InterfaceData</a></h3><div class="section-content"><p>The same PR adding a new interface that inherits from another one must update this file. Reviewers shouldn't merge PRs that don't do so.</p> <p>To test your changes, check that the sidebars of each interface you edited in your PR display inheritance correctly.</p> <p>The <code>InterfaceData.json</code> file is located <a href="https://github.com/mdn/content/blob/main/files/jsondata/InterfaceData.json" class="external" target="_blank">here</a> on GitHub.</p></div></section><section aria-labelledby="specdata_specification_information"><h2 id="specdata_specification_information"><a href="#specdata_specification_information">SpecData: Specification information</a></h2><div class="section-content"><div class="notecard warning"> <p><strong>Warning:</strong> The <code>SpecData.json</code> file is no longer maintained. Canonical specification information is stored at w3c/browser-spec and in the <code>spec_url</code> key of features at mdn/browser-compat-data.</p> </div> <p>The <code>{{SpecName}}</code> and <code>{{Spec2}}</code> macros that we are removing use the <code>SpecData.json</code> file. We do not accept any further contributions to the <code>SpecData.json</code> file; instead, either try to insert a specification table, using the <code>{{Specifications}}</code> macro, or try to hardcode the (good) link to the specification. Note that most of the time, mentioning or linking to a specification outside the <em>Specifications</em> section is a sign of something not appropriately documented on MDN.</p> <p>The <code>SpecData.json</code> file is located <a href="https://github.com/mdn/content/blob/main/files/jsondata/SpecData.json" class="external" target="_blank">here</a> on GitHub.</p></div></section></article><aside class="article-footer"><div class="article-footer-inner"><div class="svg-container"><svg xmlns="http://www.w3.org/2000/svg" width="162" height="162" viewBox="0 0 162 162" fill="none" role="none"><mask id="b" fill="#fff"><path d="M97.203 47.04c8.113-7.886 18.004-13.871 28.906-17.492a78 78 0 0 1 33.969-3.39c11.443 1.39 22.401 5.295 32.024 11.411s17.656 14.28 23.476 23.86c5.819 9.579 9.269 20.318 10.083 31.385a69.85 69.85 0 0 1-5.387 32.44c-4.358 10.272-11.115 19.443-19.747 26.801-8.632 7.359-18.908 12.709-30.034 15.637l-6.17-21.698c7.666-2.017 14.746-5.703 20.694-10.773 5.948-5.071 10.603-11.389 13.606-18.467a48.14 48.14 0 0 0 3.712-22.352c-.561-7.625-2.938-15.025-6.948-21.625s-9.544-12.226-16.175-16.44-14.181-6.904-22.065-7.863a53.75 53.75 0 0 0-23.405 2.336c-7.513 2.495-14.327 6.62-19.918 12.053z"></path></mask><path stroke="url(#a)" stroke-dasharray="6, 6" stroke-width="2" d="M97.203 47.04c8.113-7.886 18.004-13.871 28.906-17.492a78 78 0 0 1 33.969-3.39c11.443 1.39 22.401 5.295 32.024 11.411s17.656 14.28 23.476 23.86c5.819 9.579 9.269 20.318 10.083 31.385a69.85 69.85 0 0 1-5.387 32.44c-4.358 10.272-11.115 19.443-19.747 26.801-8.632 7.359-18.908 12.709-30.034 15.637l-6.17-21.698c7.666-2.017 14.746-5.703 20.694-10.773 5.948-5.071 10.603-11.389 13.606-18.467a48.14 48.14 0 0 0 3.712-22.352c-.561-7.625-2.938-15.025-6.948-21.625s-9.544-12.226-16.175-16.44-14.181-6.904-22.065-7.863a53.75 53.75 0 0 0-23.405 2.336c-7.513 2.495-14.327 6.62-19.918 12.053z" mask="url(#b)" style="stroke:url(#a)" transform="translate(-63.992 -25.587)"></path><ellipse cx="8.066" cy="111.597" fill="var(--background-tertiary)" rx="53.677" ry="53.699" transform="matrix(.71707 -.697 .7243 .6895 0 0)"></ellipse><g clip-path="url(#c)" transform="translate(-63.992 -25.587)"><path fill="#9abff5" d="m144.256 137.379 32.906 12.434a4.41 4.41 0 0 1 2.559 5.667l-9.326 24.679a4.41 4.41 0 0 1-5.667 2.559l-8.226-3.108-2.332 6.17c-.466 1.233-.375 1.883-1.609 1.417l-2.253-.527c-.411-.155-.95-.594-1.206-1.161l-4.734-10.484-12.545-4.741a4.41 4.41 0 0 1-2.559-5.667l9.325-24.679a4.41 4.41 0 0 1 5.667-2.559m9.961 29.617 8.227 3.108 3.264-8.638-.498-6.768-4.113-1.555.548 7.258-4.319-1.632zm-12.339-4.663 8.226 3.108 3.264-8.637-.498-6.769-4.113-1.554.548 7.257-4.319-1.632z"></path></g><g clip-path="url(#d)" transform="translate(-63.992 -25.587)"><path fill="#81b0f3" d="M135.35 60.136 86.67 41.654c-3.346-1.27-7.124.428-8.394 3.775L64.414 81.938c-1.27 3.347.428 7.125 3.774 8.395l12.17 4.62-3.465 9.128c-.693 1.826-1.432 2.457.394 3.15l3.014 1.625c.609.231 1.637.274 2.477-.104l15.53-6.983 18.56 7.047c3.346 1.27 7.124-.428 8.395-3.775l13.862-36.51c1.27-3.346-.428-7.124-3.775-8.395M95.261 83.207l-12.17-4.62 4.852-12.779 7.19-7.017 6.085 2.31-7.725 7.51 6.389 2.426zm18.255 6.93-12.17-4.62 4.852-12.778 7.189-7.017 6.085 2.31-7.725 7.51 6.39 2.426z"></path></g><defs><clipPath id="c"><path fill="#fff" d="m198.638 146.586-65.056-24.583-24.583 65.057 65.056 24.582z"></path></clipPath><clipPath id="d"><path fill="#fff" d="m66.438 14.055 96.242 36.54-36.54 96.243-96.243-36.54z"></path></clipPath><linearGradient id="a" x1="97.203" x2="199.995" y1="47.04" y2="152.793" gradientUnits="userSpaceOnUse"><stop stop-color="#086DFC"></stop><stop offset="0.246" stop-color="#2C81FA"></stop><stop offset="0.516" stop-color="#5497F8"></stop><stop offset="0.821" stop-color="#80B0F6"></stop><stop offset="1" stop-color="#9ABFF5"></stop></linearGradient></defs></svg></div><h2>Help improve MDN</h2><fieldset class="feedback"><label>Was this page helpful to you?</label><div class="button-container"><button type="button" class="button primary has-icon yes"><span class="button-wrap"><span class="icon icon-thumbs-up "></span>Yes</span></button><button type="button" class="button primary has-icon no"><span class="button-wrap"><span class="icon icon-thumbs-down "></span>No</span></button></div></fieldset><a class="contribute" href="https://github.com/mdn/content/blob/main/CONTRIBUTING.md" title="This will take you to our contribution guidelines on GitHub." target="_blank" rel="noopener noreferrer">Learn how to contribute</a>.<p class="last-modified-date">This page was last modified on <time dateTime="2025-01-31T16:22:51.000Z">Jan 31, 2025</time> by <a href="/en-US/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data/contributors.txt" rel="nofollow">MDN contributors</a>.</p><div id="on-github" class="on-github"><a href="https://github.com/mdn/content/blob/main/files/en-us/mdn/writing_guidelines/howto/json_structured_data/index.md?plain=1" title="Folder: en-us/mdn/writing_guidelines/howto/json_structured_data (Opens in a new tab)" target="_blank" rel="noopener noreferrer">View this page on GitHub</a> • <a href="https://github.com/mdn/content/issues/new?template=page-report.yml&mdn-url=https%3A%2F%2Fdeveloper.mozilla.org%2Fen-US%2Fdocs%2FMDN%2FWriting_guidelines%2FHowto%2FJSON_Structured_data&metadata=%3C%21--+Do+not+make+changes+below+this+line+--%3E%0A%3Cdetails%3E%0A%3Csummary%3EPage+report+details%3C%2Fsummary%3E%0A%0A*+Folder%3A+%60en-us%2Fmdn%2Fwriting_guidelines%2Fhowto%2Fjson_structured_data%60%0A*+MDN+URL%3A+https%3A%2F%2Fdeveloper.mozilla.org%2Fen-US%2Fdocs%2FMDN%2FWriting_guidelines%2FHowto%2FJSON_Structured_data%0A*+GitHub+URL%3A+https%3A%2F%2Fgithub.com%2Fmdn%2Fcontent%2Fblob%2Fmain%2Ffiles%2Fen-us%2Fmdn%2Fwriting_guidelines%2Fhowto%2Fjson_structured_data%2Findex.md%0A*+Last+commit%3A+https%3A%2F%2Fgithub.com%2Fmdn%2Fcontent%2Fcommit%2F719645a32546d9e514ac530a5eb66aa4c26d4f51%0A*+Document+last+modified%3A+2025-01-31T16%3A22%3A51.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://mastodon.social/@mdn" target="_blank" rel="me noopener noreferrer"><span class="icon icon-mastodon"></span><span class="visually-hidden">MDN on Mastodon</span></a></li><li><a href="https://twitter.com/mozdevnet" target="_blank" rel="noopener noreferrer"><span class="icon icon-twitter-x"></span><span class="visually-hidden">MDN on X (formerly Twitter)</span></a></li><li><a href="https://github.com/mdn/" target="_blank" rel="noopener noreferrer"><span class="icon icon-github-mark-small"></span><span class="visually-hidden">MDN on GitHub</span></a></li><li><a href="/en-US/blog/rss.xml" target="_blank"><span class="icon icon-feed"></span><span class="visually-hidden">MDN Blog RSS Feed</span></a></li></ul></div><div class="page-footer-nav-col-1"><h2 class="footer-nav-heading">MDN</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a href="/en-US/about">About</a></li><li class="footer-nav-item"><a href="/en-US/blog/">Blog</a></li><li class="footer-nav-item"><a href="https://www.mozilla.org/en-US/careers/listings/?team=ProdOps" target="_blank" rel="noopener noreferrer">Careers</a></li><li class="footer-nav-item"><a href="/en-US/advertising">Advertise with us</a></li></ul></div><div class="page-footer-nav-col-2"><h2 class="footer-nav-heading">Support</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="https://support.mozilla.org/products/mdn-plus">Product help</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/docs/MDN/Community/Issues">Report an issue</a></li></ul></div><div class="page-footer-nav-col-3"><h2 class="footer-nav-heading">Our communities</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/community">MDN Community</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="https://discourse.mozilla.org/c/mdn/236" target="_blank" rel="noopener noreferrer">MDN Forum</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/discord" target="_blank" rel="noopener noreferrer">MDN Chat</a></li></ul></div><div class="page-footer-nav-col-4"><h2 class="footer-nav-heading">Developers</h2><ul class="footer-nav-list"><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/docs/Web">Web Technologies</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/docs/Learn">Learn Web Development</a></li><li class="footer-nav-item"><a class="footer-nav-link" href="/en-US/plus">MDN Plus</a></li><li class="footer-nav-item"><a href="https://hacks.mozilla.org/" target="_blank" rel="noopener noreferrer">Hacks Blog</a></li></ul></div><div class="page-footer-moz"><a href="https://www.mozilla.org/" class="footer-moz-logo-link" target="_blank" rel="noopener noreferrer"><svg xmlns="http://www.w3.org/2000/svg" width="137" height="32" fill="none" viewBox="0 0 267.431 62.607"><path fill="currentColor" d="m13.913 23.056 5.33 25.356h2.195l5.33-25.356h14.267v38.976h-7.578V29.694h-2.194l-7.264 32.337h-7.343L9.418 29.694H7.223v32.337H-.354V23.056Zm47.137 9.123c9.12 0 14.423 5.385 14.423 15.214s-5.33 15.214-14.423 15.214c-9.12 0-14.423-5.385-14.423-15.214 0-9.855 5.304-15.214 14.423-15.214m0 24.363c4.285 0 6.428-2.196 6.428-7.032v-4.287c0-4.836-2.143-7.032-6.428-7.032s-6.428 2.196-6.428 7.032v4.287c0 4.836 2.143 7.032 6.428 7.032m18.473-.157 15.47-18.01h-15.26v-5.647h24.352v5.646L88.616 56.385h15.704v5.646H79.523Zm29.318-23.657h11.183V62.03h-7.578V38.375h-3.632v-5.646zm3.605-9.672h7.578v5.646h-7.578zm13.17 0h11.21v38.976h-7.578v-33.33h-3.632zm16.801 0H153.6v38.976h-7.577v-33.33h-3.632v-5.646zm29.03 9.123c4.442 0 7.394 2.143 8.231 5.881h2.194v-5.332h9.276v5.646h-3.632v18.011h3.632v5.646h-4.442c-3.135 0-4.834-1.699-4.834-4.836V56.7h-2.194c-.81 3.738-3.789 5.881-8.23 5.881-6.978 0-11.916-5.829-11.916-15.214 0-9.384 4.938-15.187 11.915-15.187m2.3 24.363c4.284 0 6.192-2.196 6.192-7.032v-4.287c0-4.836-1.908-7.032-6.193-7.032-4.18 0-6.193 2.196-6.193 7.032v4.287c0 4.836 2.012 7.032 6.193 7.032m48.34 5.489h-7.577V0h7.577zm6.585-29.643h32.165v-2.196l-21.295-7.634v-6.143l21.295-7.633V6.588h-25.345V0h32.165v12.522l-17.35 5.881V20.6l17.35 5.882v12.521h-38.985zm0-25.801h6.794v6.796h-6.794z"></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–2025 by individual mozilla.org contributors. Content available under <a href="/en-US/docs/MDN/Writing_guidelines/Attrib_copyright_license">a Creative Commons license</a>.</p></div></div></footer></div><script type="application/json" id="hydration">{"url":"/en-US/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data","doc":{"body":[{"type":"prose","value":{"id":null,"title":null,"isH3":false,"content":"<p>MDN stores data in well-defined structures when possible. This information is then centralized and can be updated once, while being used in numerous places.</p>\n<p>There are several such files, and this document describes their purpose, structure, and maintenance process.</p>"}},{"type":"prose","value":{"id":"groupdata_logical_grouping_of_apis","title":"GroupData: logical grouping of APIs","isH3":false,"content":"<p><code>GroupData</code> is a JSON file collecting information about Web APIs. The grouping of APIs is somewhat fuzzy: any interface, method or property can be part of several APIs. The set of APIs grouped under a name is a convention used to communicate about a feature, without any technical enforcement.</p>\n<p>Yet, MDN needs this information to create coherent Web-API sidebars (like with the <code>{{APIRef}}</code> macro) with the proper reference pages, guides, and overview articles.</p>\n<p>GroupData does exactly that: for each API, it lists the interfaces, properties, methods, guides, and overview pages. In the past, it also listed dictionaries and callbacks. But that use, though still supported, is deprecated and will be removed in the future.</p>"}},{"type":"prose","value":{"id":"structure_of_groupdata","title":"Structure of GroupData","isH3":true,"content":"<div class=\"notecard warning\">\n<p><strong>Warning:</strong>\nNon-existent pages listed in this file are ignored (in en-US).</p>\n</div>\n<p>An entry in <code>GroupData.json</code> has the following structure:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">json</span></div><pre class=\"brush: json notranslate\"><code>\"Name_of_the_API\": {\n \"overview\": [\"name_of_the_overview_page\"],\n \"guides\": [\n \"name_of_guide_1\",\n (…)\n ],\n \"interfaces\": [\n \"name_of_interface_1\",\n (…)\n ],\n \"methods\": [\n \"name_of_additional_method_1\",\n (…)\n ],\n \"properties\": [\n \"name_of_additional_property_1\",\n (…)\n ],\n \"events\": [\n \"name_of_additional_property_1\",\n (…)\n ]\n}\n</code></pre></div>\n<p>…where:</p>\n<dl>\n<dt id=\"name_of_the_api\"><a href=\"#name_of_the_api\"><code>\"Name_of_the_API\"</code></a></dt>\n<dd>\n<p>This key is both an ID used by sidebar macros like <code>{{APIRef(\"Name_of_the_API\")}}</code> and the name displayed in the sidebar itself. Choose it wisely.</p>\n<div class=\"notecard warning\">\n<p><strong>Warning:</strong>\nIf you want to change the name displayed in the sidebar, you must edit all the pages displaying it.</p>\n</div>\n</dd>\n<dt id=\"overview\"><a href=\"#overview\"><code>\"overview\"</code></a></dt>\n<dd>\n<p>This is a list containing one page: the overview page, used as the link for the <code>\"Name_of_the_API\"</code> text. The value is the <em>title of the page</em>, and the page must be in the <code>web/api/</code> directory.</p>\n</dd>\n<dt id=\"guides\"><a href=\"#guides\"><code>\"guides\"</code></a></dt>\n<dd>\n<p>This is a list of guides to display in the sidebar, in the given order. The values are <em>paths to the page</em>, starting with <code>/docs/</code>.</p>\n</dd>\n<dt id=\"interfaces\"><a href=\"#interfaces\"><code>\"interfaces\"</code></a></dt>\n<dd>\n<p>This lists the interfaces that are part of the API.</p>\n</dd>\n<dt id=\"methods\"><a href=\"#methods\"><code>\"methods\"</code></a></dt>\n<dd>\n<p>This lists the methods that are part of the API.</p>\n<div class=\"notecard note\">\n<p><strong>Note:</strong>\nThe methods of the interfaces listed in <code>\"interfaces\"</code> <strong>must</strong> not be listed there. They are automatically added to the sidebar if the <code>page-type</code> key for that page is <code>web-api-static-method</code> or <code>web-api-instance-method</code>.</p>\n</div>\n</dd>\n<dt id=\"properties\"><a href=\"#properties\"><code>\"properties\"</code></a></dt>\n<dd>\n<p>This lists the properties on other interfaces that are part of the API, like <code>navigator.xr</code> (a property that the WebXR API adds to the <code>navigator</code> object)</p>\n<div class=\"notecard note\">\n<p><strong>Note:</strong>\nThe properties of the interfaces listed in <code>\"interfaces\"</code> <strong>must</strong> not be listed there. They are automatically added to the sidebar if the <code>page-type</code> key for that page is <code>web-api-static-property</code> or <code>web-api-instance-property</code>.</p>\n</div>\n</dd>\n<dt id=\"events\"><a href=\"#events\"><code>\"events\"</code></a></dt>\n<dd>\n<p>This lists events of other interfaces that are part of the API. The values are the <em>title of the pages</em> (that must reside under <code>Web/Events</code>)</p>\n<div class=\"notecard note\">\n<p><strong>Note:</strong>\nThe events targeting the interfaces listed in <code>\"interfaces\"</code> <strong>must</strong> not be listed there. They are automatically added to the sidebar if the <code>page-type</code> key for that page is <code>web-api-event</code>.</p>\n</div>\n</dd>\n</dl>\n<p>There are two other keys, <code>\"dictionaries\"</code> and <code>\"callbacks\"</code>, operating on the same principle. As we no longer document these entities in their own pages, their use is deprecated, and no new entry should be added to them (and we remove them little by little).</p>\n<div class=\"notecard note\">\n<p><strong>Note:</strong>\nAlso, none of the keys are mandatory; it is good practice (and we'll enforce this) to add the non-deprecated ones with an empty list rather than omitting them. It shows that the absence of value is a conscious choice.</p>\n</div>"}},{"type":"prose","value":{"id":"update_process_for_groupdata","title":"Update process for GroupData","isH3":true,"content":"<p>This file should be updated in the same PR where changes affecting the sidebar happens. That way, the sidebar is always up-to-date. Reviewers shouldn't merge PRs that don't adopt it.</p>\n<p>To test your changes, check that the sidebar in the files in your PR displays all entries correctly.</p>\n<p>The <code>GroupData.json</code> file is located <a href=\"https://github.com/mdn/content/blob/main/files/jsondata/GroupData.json\" class=\"external\" target=\"_blank\">here</a> on GitHub.</p>"}},{"type":"prose","value":{"id":"interfacedata_recording_interface_inheritance","title":"InterfaceData: recording interface inheritance","isH3":false,"content":"<div class=\"notecard note\">\n<p><strong>Note:</strong>\nWe hope to generate this file automatically from the data available via w3c/webref in the future.</p>\n</div>\n<p><code>InterfaceData</code> describes the hierarchy of the interfaces. It lists inheritance. In the past, it also listed mixins implemented by each interface; but that usage is deprecated, and we remove mixins from this file at the same rate MDN is updated.</p>\n<p>This inheritance data is used when building API sidebars and by the <code>{{InheritanceDiagram}}</code> in the interface pages.</p>"}},{"type":"prose","value":{"id":"structure_of_interfacedata","title":"Structure of InterfaceData","isH3":true,"content":"<p>An entry in <code>InterfaceData.json</code> has the following structure:</p>\n<div class=\"code-example\"><div class=\"example-header\"><span class=\"language-name\">json</span></div><pre class=\"brush: json notranslate\"><code>\"Name_of_the_interface\": {\n \"inh\": \"Name_of_the_parent_interface\",\n \"impl\": []\n}\n</code></pre></div>\n<div class=\"notecard note\">\n<p><strong>Note:</strong>\nAs mixins are deprecated, <code>\"impl\"</code> must be an empty list for all new interfaces.</p>\n</div>\n<p>The value of <code>\"Name_of_the_parent_interface\"</code> is not a list but a single entry, mandatory; we must not list any interface that don't inherit from another one.</p>"}},{"type":"prose","value":{"id":"update_process_for_interfacedata","title":"Update process for InterfaceData","isH3":true,"content":"<p>The same PR adding a new interface that inherits from another one must update this file. Reviewers shouldn't merge PRs that don't do so.</p>\n<p>To test your changes, check that the sidebars of each interface you edited in your PR display inheritance correctly.</p>\n<p>The <code>InterfaceData.json</code> file is located <a href=\"https://github.com/mdn/content/blob/main/files/jsondata/InterfaceData.json\" class=\"external\" target=\"_blank\">here</a> on GitHub.</p>"}},{"type":"prose","value":{"id":"specdata_specification_information","title":"SpecData: Specification information","isH3":false,"content":"<div class=\"notecard warning\">\n<p><strong>Warning:</strong>\nThe <code>SpecData.json</code> file is no longer maintained. Canonical specification information is stored at w3c/browser-spec and in the <code>spec_url</code> key of features at mdn/browser-compat-data.</p>\n</div>\n<p>The <code>{{SpecName}}</code> and <code>{{Spec2}}</code> macros that we are removing use the <code>SpecData.json</code> file. We do not accept any further contributions to the <code>SpecData.json</code> file; instead, either try to insert a specification table, using the <code>{{Specifications}}</code> macro, or try to hardcode the (good) link to the specification. Note that most of the time, mentioning or linking to a specification outside the <em>Specifications</em> section is a sign of something not appropriately documented on MDN.</p>\n<p>The <code>SpecData.json</code> file is located <a href=\"https://github.com/mdn/content/blob/main/files/jsondata/SpecData.json\" class=\"external\" target=\"_blank\">here</a> on GitHub.</p>"}}],"isActive":true,"isMarkdown":true,"isTranslated":false,"locale":"en-US","mdn_url":"/en-US/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data","modified":"2025-01-31T16:22:51.000Z","native":"English (US)","noIndexing":false,"other_translations":[{"locale":"de","title":"Anleitung zur Verwendung strukturierter Daten","native":"Deutsch"},{"locale":"es","title":"Cómo usar datos estructurados","native":"Español"},{"locale":"ja","title":"構造化データの使用方法","native":"日本語"},{"locale":"zh-CN","title":"如何使用结构化数据","native":"中文 (简体)"}],"pageTitle":"How to use structured data - MDN Web Docs | MDN","parents":[{"uri":"/en-US/docs/MDN","title":"MDN Web Docs"},{"uri":"/en-US/docs/MDN/Writing_guidelines","title":"Writing guidelines"},{"uri":"/en-US/docs/MDN/Writing_guidelines/Howto","title":"How-to"},{"uri":"/en-US/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data","title":"Use structured data"}],"popularity":null,"short_title":"Use structured data","sidebarHTML":"<ol><li class=\"section\"><a href=\"/en-US/docs/MDN\">MDN Web Docs</a></li><li><a href=\"/en-US/docs/MDN/Tutorials\">Tutorials</a></li><li><a href=\"/en-US/docs/MDN/Guides\">Guides</a></li><li class=\"toggle\"><details><summary>Community resources</summary><ol><li><a href=\"/en-US/docs/MDN/Community\">Resources</a></li><li><a href=\"/en-US/docs/MDN/Community/Getting_started\">Getting started</a></li><li><a href=\"/en-US/docs/MDN/Community/Our_repositories\">GitHub repositories</a></li><li><a href=\"/en-US/docs/MDN/Community/Open_source_etiquette\">Open source etiquette</a></li><li><a href=\"/en-US/docs/MDN/Community/Issues\">Creating and working on issues</a></li><li><a href=\"/en-US/docs/MDN/Community/Pull_requests\">Pull request submission and reviews</a></li><li><a href=\"/en-US/docs/MDN/Community/Discussions\">GitHub Discussions</a></li><li><a href=\"/en-US/docs/MDN/Community/Translated_content\">Localization</a></li><li><a href=\"/en-US/docs/MDN/Community/Roles_teams\">Roles and teams</a></li><li><a href=\"/en-US/docs/MDN/Community/Communication_channels\">Communication channels</a></li><li><a href=\"/en-US/docs/MDN/Community/Learn_forum\">Learn forum</a></li></ol></details></li><li class=\"toggle\"><details open=\"\"><summary>Writing guidelines</summary><ol><li><a href=\"/en-US/docs/MDN/Writing_guidelines\">Writing guidelines</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/What_we_write\">What we write</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Writing_style_guide\">Style guide</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Learning_content\">Learning content guidelines</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete\">Experimental, deprecated, and obsolete</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Attrib_copyright_license\">Attribution and copyright licensing</a></li><li class=\"toggle\"><details open=\"\"><summary>How-to guides</summary><ol><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto\">Overview</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary\">Add a glossary entry</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Images_media\">Add media</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting\">Create, edit, move, or delete pages</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Document_a_CSS_property\">Document a CSS property</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Document_an_HTTP_header\">Document an HTTP header</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Document_web_errors\">Document errors</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Research_technology\">Research a technology</a></li><li><em><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/JSON_Structured_data\" aria-current=\"page\">Use structured data</a></em></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Write_an_api_reference\">Write an API reference</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN\">Write in Markdown</a></li></ol></details></li><li class=\"toggle\"><details><summary>Page structures</summary><ol><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures\">Overview</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Banners_and_notices\">Banners and notices</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Code_examples\">Code examples</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Compatibility_tables\">Compatibility tables and the browser compatibility data repository (BCD)</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Feature_status\">Feature status</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Links\">Link macros</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Live_samples\">Live examples</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types\">Page types</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Sidebars\">Sidebars</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Specification_tables\">Specification tables</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Syntax_sections\">Syntax sections</a></li><li><a href=\"/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros\">Using macros</a></li></ol></details></li></ol></details></li></ol>","sidebarMacro":"mdnsidebar","source":{"folder":"en-us/mdn/writing_guidelines/howto/json_structured_data","github_url":"https://github.com/mdn/content/blob/main/files/en-us/mdn/writing_guidelines/howto/json_structured_data/index.md","last_commit_url":"https://github.com/mdn/content/commit/719645a32546d9e514ac530a5eb66aa4c26d4f51","filename":"index.md"},"summary":"MDN stores data in well-defined structures when possible. This information is then centralized and can be updated once, while being used in numerous places.","title":"How to use structured data","toc":[{"text":"GroupData: logical grouping of APIs","id":"groupdata_logical_grouping_of_apis"},{"text":"InterfaceData: recording interface inheritance","id":"interfacedata_recording_interface_inheritance"},{"text":"SpecData: Specification information","id":"specdata_specification_information"}],"pageType":"mdn-writing-guide"}}</script></body></html>