Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Sep 8, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions docs/api/accordion-group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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]}
/>


Expand Down
5 changes: 2 additions & 3 deletions docs/api/action-sheet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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]}
/>


Expand Down
5 changes: 2 additions & 3 deletions docs/api/app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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]}
/>


Expand Down
5 changes: 2 additions & 3 deletions docs/api/back-button.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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]}
/>


Expand Down
7 changes: 2 additions & 5 deletions docs/api/backdrop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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]}
/>


Expand Down
7 changes: 2 additions & 5 deletions docs/api/breadcrumb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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]}
/>


Expand Down
10 changes: 4 additions & 6 deletions docs/api/button.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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
Expand Down
5 changes: 2 additions & 3 deletions docs/api/buttons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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]}
/>


Expand Down
9 changes: 2 additions & 7 deletions docs/api/card-content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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]}
/>


Expand Down
7 changes: 2 additions & 5 deletions docs/api/card-header.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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]}
/>


Expand Down
7 changes: 2 additions & 5 deletions docs/api/card-subtitle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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]}
/>


Expand Down
9 changes: 4 additions & 5 deletions docs/api/card-title.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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]}
/>


Expand Down
9 changes: 4 additions & 5 deletions docs/api/card.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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]}
/>


Expand Down
1 change: 0 additions & 1 deletion docs/api/checkbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" />

Expand Down
Loading