fix(docs): TOC navigation renders correct headings (#2539)

ionic-team · Sep 8, 2022 · 9ede9a3 · 9ede9a3
1 parent c4c9287
commit 9ede9a3
Show file tree

Hide file tree

Showing 73 changed files with 149 additions and 299 deletions.
diff --git a/docs/api/accordion-group.md b/docs/api/accordion-group.md
@@ -4,6 +4,7 @@ hide_table_of_contents: true
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import TOCInline from '@theme/TOCInline';
 
 import Props from '@site/static/auto-generated/accordion-group/props.md';
 import Events from '@site/static/auto-generated/accordion-group/events.md';
@@ -12,19 +13,15 @@ import Parts from '@site/static/auto-generated/accordion-group/parts.md';
 import CustomProps from '@site/static/auto-generated/accordion-group/custom-props.md';
 import Slots from '@site/static/auto-generated/accordion-group/slots.md';
 
-
-
 import EncapsulationPill from '@components/page/api/EncapsulationPill';
-import APITOCInline from '@components/page/api/APITOCInline';
 
 <EncapsulationPill type="shadow" />
 
 <h2 className="table-of-contents__title">Contents</h2>
 
-<APITOCInline
+<TOCInline
   toc={toc}
   maxHeadingLevel={2}
-  autogenerated={[Props, Events, Methods, Parts, CustomProps, Slots]}
 />
 
 

diff --git a/docs/api/action-sheet.md b/docs/api/action-sheet.md
@@ -6,6 +6,7 @@ demoSourceUrl: "https://github.com/ionic-team/ionic-docs/tree/main/static/demos/
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import TOCInline from '@theme/TOCInline';
 
 import Props from '@site/static/auto-generated/action-sheet/props.md';
 import Events from '@site/static/auto-generated/action-sheet/events.md';
@@ -20,16 +21,14 @@ import Slots from '@site/static/auto-generated/action-sheet/slots.md';
 </head>
 
 import EncapsulationPill from '@components/page/api/EncapsulationPill';
-import APITOCInline from '@components/page/api/APITOCInline';
 
 <EncapsulationPill type="scoped" />
 
 <h2 className="table-of-contents__title">Contents</h2>
 
-<APITOCInline
+<TOCInline
   toc={toc}
   maxHeadingLevel={2}
-  autogenerated={[Props, Events, Methods, Parts, CustomProps, Slots]}
 />
 
 

diff --git a/docs/api/app.md b/docs/api/app.md
@@ -4,6 +4,7 @@ hide_table_of_contents: true
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import TOCInline from '@theme/TOCInline';
 
 import Props from '@site/static/auto-generated/app/props.md';
 import Events from '@site/static/auto-generated/app/events.md';
@@ -18,16 +19,14 @@ import Slots from '@site/static/auto-generated/app/slots.md';
 </head>
 
 import EncapsulationPill from '@components/page/api/EncapsulationPill';
-import APITOCInline from '@components/page/api/APITOCInline';
 
 
 
 <h2 className="table-of-contents__title">Contents</h2>
 
-<APITOCInline
+<TOCInline
   toc={toc}
   maxHeadingLevel={2}
-  autogenerated={[Props, Events, Methods, Parts, CustomProps, Slots]}
 />
 
 

diff --git a/docs/api/back-button.md b/docs/api/back-button.md
@@ -6,6 +6,7 @@ demoSourceUrl: "https://github.com/ionic-team/ionic-docs/tree/main/static/demos/
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import TOCInline from '@theme/TOCInline';
 
 import Props from '@site/static/auto-generated/back-button/props.md';
 import Events from '@site/static/auto-generated/back-button/events.md';
@@ -20,16 +21,14 @@ import Slots from '@site/static/auto-generated/back-button/slots.md';
 </head>
 
 import EncapsulationPill from '@components/page/api/EncapsulationPill';
-import APITOCInline from '@components/page/api/APITOCInline';
 
 <EncapsulationPill type="shadow" />
 
 <h2 className="table-of-contents__title">Contents</h2>
 
-<APITOCInline
+<TOCInline
   toc={toc}
   maxHeadingLevel={2}
-  autogenerated={[Props, Events, Methods, Parts, CustomProps, Slots]}
 />
 
 

diff --git a/docs/api/backdrop.md b/docs/api/backdrop.md
@@ -6,6 +6,7 @@ demoSourceUrl: "https://github.com/ionic-team/ionic-docs/tree/main/static/demos/
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import TOCInline from '@theme/TOCInline';
 
 import Props from '@site/static/auto-generated/backdrop/props.md';
 import Events from '@site/static/auto-generated/backdrop/events.md';
@@ -14,19 +15,15 @@ import Parts from '@site/static/auto-generated/backdrop/parts.md';
 import CustomProps from '@site/static/auto-generated/backdrop/custom-props.md';
 import Slots from '@site/static/auto-generated/backdrop/slots.md';
 
-
-
 import EncapsulationPill from '@components/page/api/EncapsulationPill';
-import APITOCInline from '@components/page/api/APITOCInline';
 
 <EncapsulationPill type="shadow" />
 
 <h2 className="table-of-contents__title">Contents</h2>
 
-<APITOCInline
+<TOCInline
   toc={toc}
   maxHeadingLevel={2}
-  autogenerated={[Props, Events, Methods, Parts, CustomProps, Slots]}
 />
 
 

diff --git a/docs/api/breadcrumb.md b/docs/api/breadcrumb.md
@@ -4,6 +4,7 @@ hide_table_of_contents: true
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import TOCInline from '@theme/TOCInline';
 
 import Props from '@site/static/auto-generated/breadcrumb/props.md';
 import Events from '@site/static/auto-generated/breadcrumb/events.md';
@@ -12,19 +13,15 @@ import Parts from '@site/static/auto-generated/breadcrumb/parts.md';
 import CustomProps from '@site/static/auto-generated/breadcrumb/custom-props.md';
 import Slots from '@site/static/auto-generated/breadcrumb/slots.md';
 
-
-
 import EncapsulationPill from '@components/page/api/EncapsulationPill';
-import APITOCInline from '@components/page/api/APITOCInline';
 
 <EncapsulationPill type="shadow" />
 
 <h2 className="table-of-contents__title">Contents</h2>
 
-<APITOCInline
+<TOCInline
   toc={toc}
   maxHeadingLevel={2}
-  autogenerated={[Props, Events, Methods, Parts, CustomProps, Slots]}
 />
 
 

diff --git a/docs/api/button.md b/docs/api/button.md
@@ -6,6 +6,7 @@ demoSourceUrl: "https://github.com/ionic-team/ionic-docs/tree/main/static/demos/
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import TOCInline from '@theme/TOCInline';
 
 import Props from '@site/static/auto-generated/button/props.md';
 import Events from '@site/static/auto-generated/button/events.md';
@@ -14,26 +15,23 @@ import Parts from '@site/static/auto-generated/button/parts.md';
 import CustomProps from '@site/static/auto-generated/button/custom-props.md';
 import Slots from '@site/static/auto-generated/button/slots.md';
 
+import EncapsulationPill from '@components/page/api/EncapsulationPill';
+
 <head>
   <title>ion-button: Design and Style Buttons with Custom CSS Properties</title>
   <meta name="description" content="ion-button provides a clickable element for use anywhere needing standard button functionality. Design and style button elements with custom CSS properties." />
 </head>
 
-import EncapsulationPill from '@components/page/api/EncapsulationPill';
-import APITOCInline from '@components/page/api/APITOCInline';
 
 <EncapsulationPill type="shadow" />
 
 <h2 className="table-of-contents__title">Contents</h2>
 
-<APITOCInline
+<TOCInline
   toc={toc}
   maxHeadingLevel={2}
-  autogenerated={[Props, Events, Methods, Parts, CustomProps, Slots]}
 />
 
-
-
 Buttons provide a clickable element, which can be used in forms, or anywhere that needs simple, standard button functionality. They may display text, icons, or both. Buttons can be styled with several attributes to look a specific way.
 
 ## Expand

diff --git a/docs/api/buttons.md b/docs/api/buttons.md
@@ -4,6 +4,7 @@ hide_table_of_contents: true
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import TOCInline from '@theme/TOCInline';
 
 import Props from '@site/static/auto-generated/buttons/props.md';
 import Events from '@site/static/auto-generated/buttons/events.md';
@@ -18,16 +19,14 @@ import Slots from '@site/static/auto-generated/buttons/slots.md';
 </head>
 
 import EncapsulationPill from '@components/page/api/EncapsulationPill';
-import APITOCInline from '@components/page/api/APITOCInline';
 
 <EncapsulationPill type="scoped" />
 
 <h2 className="table-of-contents__title">Contents</h2>
 
-<APITOCInline
+<TOCInline
   toc={toc}
   maxHeadingLevel={2}
-  autogenerated={[Props, Events, Methods, Parts, CustomProps, Slots]}
 />
 
 

diff --git a/docs/api/card-content.md b/docs/api/card-content.md
@@ -4,6 +4,7 @@ hide_table_of_contents: true
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import TOCInline from '@theme/TOCInline';
 
 import Props from '@site/static/auto-generated/card-content/props.md';
 import Events from '@site/static/auto-generated/card-content/events.md';
@@ -12,19 +13,13 @@ import Parts from '@site/static/auto-generated/card-content/parts.md';
 import CustomProps from '@site/static/auto-generated/card-content/custom-props.md';
 import Slots from '@site/static/auto-generated/card-content/slots.md';
 
-
-
 import EncapsulationPill from '@components/page/api/EncapsulationPill';
-import APITOCInline from '@components/page/api/APITOCInline';
-
-
 
 <h2 className="table-of-contents__title">Contents</h2>
 
-<APITOCInline
+<TOCInline
   toc={toc}
   maxHeadingLevel={2}
-  autogenerated={[Props, Events, Methods, Parts, CustomProps, Slots]}
 />
 
 

diff --git a/docs/api/card-header.md b/docs/api/card-header.md
@@ -4,6 +4,7 @@ hide_table_of_contents: true
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import TOCInline from '@theme/TOCInline';
 
 import Props from '@site/static/auto-generated/card-header/props.md';
 import Events from '@site/static/auto-generated/card-header/events.md';
@@ -12,19 +13,15 @@ import Parts from '@site/static/auto-generated/card-header/parts.md';
 import CustomProps from '@site/static/auto-generated/card-header/custom-props.md';
 import Slots from '@site/static/auto-generated/card-header/slots.md';
 
-
-
 import EncapsulationPill from '@components/page/api/EncapsulationPill';
-import APITOCInline from '@components/page/api/APITOCInline';
 
 <EncapsulationPill type="shadow" />
 
 <h2 className="table-of-contents__title">Contents</h2>
 
-<APITOCInline
+<TOCInline
   toc={toc}
   maxHeadingLevel={2}
-  autogenerated={[Props, Events, Methods, Parts, CustomProps, Slots]}
 />
 
 

diff --git a/docs/api/card-subtitle.md b/docs/api/card-subtitle.md
@@ -4,6 +4,7 @@ hide_table_of_contents: true
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import TOCInline from '@theme/TOCInline';
 
 import Props from '@site/static/auto-generated/card-subtitle/props.md';
 import Events from '@site/static/auto-generated/card-subtitle/events.md';
@@ -12,19 +13,15 @@ import Parts from '@site/static/auto-generated/card-subtitle/parts.md';
 import CustomProps from '@site/static/auto-generated/card-subtitle/custom-props.md';
 import Slots from '@site/static/auto-generated/card-subtitle/slots.md';
 
-
-
 import EncapsulationPill from '@components/page/api/EncapsulationPill';
-import APITOCInline from '@components/page/api/APITOCInline';
 
 <EncapsulationPill type="shadow" />
 
 <h2 className="table-of-contents__title">Contents</h2>
 
-<APITOCInline
+<TOCInline
   toc={toc}
   maxHeadingLevel={2}
-  autogenerated={[Props, Events, Methods, Parts, CustomProps, Slots]}
 />
 
 

diff --git a/docs/api/card-title.md b/docs/api/card-title.md
@@ -4,6 +4,7 @@ hide_table_of_contents: true
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import TOCInline from '@theme/TOCInline';
 
 import Props from '@site/static/auto-generated/card-title/props.md';
 import Events from '@site/static/auto-generated/card-title/events.md';
@@ -12,22 +13,20 @@ import Parts from '@site/static/auto-generated/card-title/parts.md';
 import CustomProps from '@site/static/auto-generated/card-title/custom-props.md';
 import Slots from '@site/static/auto-generated/card-title/slots.md';
 
+import EncapsulationPill from '@components/page/api/EncapsulationPill';
+
 <head>
   <title>ion-card-title | Ionic App Card Title Component and Properties</title>
   <meta name="description" content="ion-card-title is a child component of ion-card. Read to learn more about card title properties and how this component is used on Ionic Framework apps." />
 </head>
 
-import EncapsulationPill from '@components/page/api/EncapsulationPill';
-import APITOCInline from '@components/page/api/APITOCInline';
-
 <EncapsulationPill type="shadow" />
 
 <h2 className="table-of-contents__title">Contents</h2>
 
-<APITOCInline
+<TOCInline
   toc={toc}
   maxHeadingLevel={2}
-  autogenerated={[Props, Events, Methods, Parts, CustomProps, Slots]}
 />
 
 

diff --git a/docs/api/card.md b/docs/api/card.md
@@ -6,6 +6,7 @@ demoSourceUrl: "https://github.com/ionic-team/ionic-docs/tree/main/static/demos/
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import TOCInline from '@theme/TOCInline';
 
 import Props from '@site/static/auto-generated/card/props.md';
 import Events from '@site/static/auto-generated/card/events.md';
@@ -14,22 +15,20 @@ import Parts from '@site/static/auto-generated/card/parts.md';
 import CustomProps from '@site/static/auto-generated/card/custom-props.md';
 import Slots from '@site/static/auto-generated/card/slots.md';
 
+import EncapsulationPill from '@components/page/api/EncapsulationPill';
+
 <head>
   <title>ion-card: Card UI Components for Ionic Framework API</title>
   <meta name="description" content="ion-card UI components are entry points to more detailed information. Cards can be single components or made up of some header, title, subtitle, and content." />
 </head>
 
-import EncapsulationPill from '@components/page/api/EncapsulationPill';
-import APITOCInline from '@components/page/api/APITOCInline';
-
 <EncapsulationPill type="shadow" />
 
 <h2 className="table-of-contents__title">Contents</h2>
 
-<APITOCInline
+<TOCInline
   toc={toc}
   maxHeadingLevel={2}
-  autogenerated={[Props, Events, Methods, Parts, CustomProps, Slots]}
 />
 
 

diff --git a/docs/api/checkbox.md b/docs/api/checkbox.md
@@ -15,7 +15,6 @@ import Slots from '@site/static/auto-generated/checkbox/slots.md';
 </head>
 
 import EncapsulationPill from '@components/page/api/EncapsulationPill';
-import APITOCInline from '@components/page/api/APITOCInline';
 
 <EncapsulationPill type="shadow" />
-Original file line number
+Diff line change
@@ Expand Up @@
     </head>
     import EncapsulationPill from '@components/page/api/EncapsulationPill';
-    import APITOCInline from '@components/page/api/APITOCInline';
     <EncapsulationPill type="shadow" />
@@ Expand Down @@