docusaurus/assets/js/1864f992.c414f5b7.js

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[83918],{12111:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>u,contentTitle:()=>r,default:()=>l,frontMatter:()=>a,metadata:()=>d,toc:()=>c});var i=n(24246),t=n(71670);const a={slug:"/api/misc/@docusaurus/eslint-plugin/prefer-docusaurus-heading"},r="prefer-docusaurus-heading",d={id:"api/misc/eslint-plugin/prefer-docusaurus-heading",title:"prefer-docusaurus-heading",description:"Ensures that the @theme/Heading theme component provided by Docusaurus theme-classic is used instead of `` tags for headings.",source:"@site/docs/api/misc/eslint-plugin/prefer-docusaurus-heading.mdx",sourceDirName:"api/misc/eslint-plugin",slug:"/api/misc/@docusaurus/eslint-plugin/prefer-docusaurus-heading",permalink:"/docs/api/misc/@docusaurus/eslint-plugin/prefer-docusaurus-heading",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/edit/main/website/docs/api/misc/eslint-plugin/prefer-docusaurus-heading.mdx",tags:[],version:"current",lastUpdatedBy:"S\xe9bastien Lorber",lastUpdatedAt:1721394658e3,frontMatter:{slug:"/api/misc/@docusaurus/eslint-plugin/prefer-docusaurus-heading"},sidebar:"api",previous:{title:"no-untranslated-text",permalink:"/docs/api/misc/@docusaurus/eslint-plugin/no-untranslated-text"},next:{title:"string-literal-i18n-messages",permalink:"/docs/api/misc/@docusaurus/eslint-plugin/string-literal-i18n-messages"}},u={},c=[{value:"Rule Details",id:"details",level:2}];function o(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"prefer-docusaurus-heading",children:"prefer-docusaurus-heading"}),"\n",(0,i.jsxs)(s.p,{children:["Ensures that the ",(0,i.jsx)(s.code,{children:"@theme/Heading"})," theme component provided by Docusaurus ",(0,i.jsx)(s.a,{href:"/docs/api/themes/@docusaurus/theme-classic",children:(0,i.jsx)(s.code,{children:"theme-classic"})})," is used instead of ",(0,i.jsx)(s.code,{children:"<hn>"})," tags for headings."]}),"\n",(0,i.jsx)(s.h2,{id:"details",children:"Rule Details"}),"\n",(0,i.jsxs)(s.p,{children:["Examples of ",(0,i.jsx)(s.strong,{children:"incorrect"})," code for this rule:"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-html",children:"<h1>This is heading 1</h1>\n\n<h2>This is heading 2</h2>\n\n<h3>This is heading 3</h3>\n"})}),"\n",(0,i.jsxs)(s.p,{children:["Examples of ",(0,i.jsx)(s.strong,{children:"correct"})," code for this rule:"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-javascript",children:"import Heading from '@theme/Heading'\n\n<Heading as='h1'>This is heading 1</Heading>\n\n<Heading as='h2'>This is heading 2</Heading>\n\n<Heading as='h3'>This is heading 3</Heading>\n"})})]})}function l(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>d,a:()=>r});var i=n(27378);const t={},a=i.createContext(t);function r(e){const s=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(a.Provider,{value:s},e.children)}}}]);