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

Jump to bottom

feat: docusaurus plugin to generate component api docs #2829

Merged
merged 12 commits into from
Mar 29, 2023
Merged

feat: docusaurus plugin to generate component api docs #2829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
ce67296
chore: update api script to version api docs
sean-perkins Feb 24, 2023
6a5e802
chore: update v7 md docs to use v7 directory for api reference
sean-perkins Feb 24, 2023
d7a91b8
chore: update v6 md docs to use v6 directory for api reference
sean-perkins Feb 24, 2023
391def0
feat: docusaurus plugin to generate component api docs
sean-perkins Feb 28, 2023
9fa4064
chore: migrate import paths
sean-perkins Feb 28, 2023
7a93e72
chore: generate markdown in plugin dir
sean-perkins Feb 28, 2023
3bb998d
chore: update import paths
sean-perkins Feb 28, 2023
8607e99
chore: remove auto-generated files that were pushed to git
sean-perkins Feb 28, 2023
e6ad046
chore: remove unused code
sean-perkins Feb 28, 2023
56ac5ed
chore: cleanly named import paths
sean-perkins Mar 2, 2023
ca94d9f
refactor: use versions.json for generating markdown
sean-perkins Mar 6, 2023
c3c098e
Merge remote-tracking branch 'origin/main' into feat/docusaurus-plugi…
liamdebeasi Mar 29, 2023
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
12 changes: 6 additions & 6 deletions docs/api/accordion-group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-accordion-group"
---
import Props from '@site/static/auto-generated/accordion-group/props.md';
import Events from '@site/static/auto-generated/accordion-group/events.md';
import Methods from '@site/static/auto-generated/accordion-group/methods.md';
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 Props from '@ionic-internal/component-api/v7/accordion-group/props.md';
import Events from '@ionic-internal/component-api/v7/accordion-group/events.md';
import Methods from '@ionic-internal/component-api/v7/accordion-group/methods.md';
import Parts from '@ionic-internal/component-api/v7/accordion-group/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/accordion-group/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/accordion-group/slots.md';

import EncapsulationPill from '@components/page/api/EncapsulationPill';

Expand Down
12 changes: 6 additions & 6 deletions docs/api/accordion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-accordion"
---
import Props from '@site/static/auto-generated/accordion/props.md';
import Events from '@site/static/auto-generated/accordion/events.md';
import Methods from '@site/static/auto-generated/accordion/methods.md';
import Parts from '@site/static/auto-generated/accordion/parts.md';
import CustomProps from '@site/static/auto-generated/accordion/custom-props.md';
import Slots from '@site/static/auto-generated/accordion/slots.md';
import Props from '@ionic-internal/component-api/v7/accordion/props.md';
import Events from '@ionic-internal/component-api/v7/accordion/events.md';
import Methods from '@ionic-internal/component-api/v7/accordion/methods.md';
import Parts from '@ionic-internal/component-api/v7/accordion/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/accordion/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/accordion/slots.md';

<head>
<title>Ion-Accordion Components: How to Build & Examples | Ionic</title>
Expand Down
12 changes: 6 additions & 6 deletions docs/api/action-sheet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-action-sheet"
---
import Props from '@site/static/auto-generated/action-sheet/props.md';
import Events from '@site/static/auto-generated/action-sheet/events.md';
import Methods from '@site/static/auto-generated/action-sheet/methods.md';
import Parts from '@site/static/auto-generated/action-sheet/parts.md';
import CustomProps from '@site/static/auto-generated/action-sheet/custom-props.md';
import Slots from '@site/static/auto-generated/action-sheet/slots.md';
import Props from '@ionic-internal/component-api/v7/action-sheet/props.md';
import Events from '@ionic-internal/component-api/v7/action-sheet/events.md';
import Methods from '@ionic-internal/component-api/v7/action-sheet/methods.md';
import Parts from '@ionic-internal/component-api/v7/action-sheet/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/action-sheet/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/action-sheet/slots.md';

<head>
<title>ion-action-sheet | Action Sheet Dialog for iOS and Android Apps</title>
Expand Down
12 changes: 6 additions & 6 deletions docs/api/alert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ title: "ion-alert"
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

import Props from '@site/static/auto-generated/alert/props.md';
import Events from '@site/static/auto-generated/alert/events.md';
import Methods from '@site/static/auto-generated/alert/methods.md';
import Parts from '@site/static/auto-generated/alert/parts.md';
import CustomProps from '@site/static/auto-generated/alert/custom-props.md';
import Slots from '@site/static/auto-generated/alert/slots.md';
import Props from '@ionic-internal/component-api/v7/alert/props.md';
import Events from '@ionic-internal/component-api/v7/alert/events.md';
import Methods from '@ionic-internal/component-api/v7/alert/methods.md';
import Parts from '@ionic-internal/component-api/v7/alert/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/alert/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/alert/slots.md';

<head>
<title>ion-alert: Ionic API Alert Buttons with Custom Message Prompts</title>
Expand Down
12 changes: 6 additions & 6 deletions docs/api/app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-app"
---
import Props from '@site/static/auto-generated/app/props.md';
import Events from '@site/static/auto-generated/app/events.md';
import Methods from '@site/static/auto-generated/app/methods.md';
import Parts from '@site/static/auto-generated/app/parts.md';
import CustomProps from '@site/static/auto-generated/app/custom-props.md';
import Slots from '@site/static/auto-generated/app/slots.md';
import Props from '@ionic-internal/component-api/v7/app/props.md';
import Events from '@ionic-internal/component-api/v7/app/events.md';
import Methods from '@ionic-internal/component-api/v7/app/methods.md';
import Parts from '@ionic-internal/component-api/v7/app/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/app/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/app/slots.md';

<head>
<title>ion-app: Container Element for an Ionic Application</title>
Expand Down
12 changes: 6 additions & 6 deletions docs/api/avatar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
title: "ion-avatar"
---

import Props from '@site/static/auto-generated/avatar/props.md';
import Events from '@site/static/auto-generated/avatar/events.md';
import Methods from '@site/static/auto-generated/avatar/methods.md';
import Parts from '@site/static/auto-generated/avatar/parts.md';
import CustomProps from '@site/static/auto-generated/avatar/custom-props.md';
import Slots from '@site/static/auto-generated/avatar/slots.md';
import Props from '@ionic-internal/component-api/v7/avatar/props.md';
import Events from '@ionic-internal/component-api/v7/avatar/events.md';
import Methods from '@ionic-internal/component-api/v7/avatar/methods.md';
import Parts from '@ionic-internal/component-api/v7/avatar/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/avatar/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/avatar/slots.md';

<head>
<title>ion-avatar: Circular Application Avatar Icon Component</title>
Expand Down
12 changes: 6 additions & 6 deletions docs/api/back-button.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-back-button"
---
import Props from '@site/static/auto-generated/back-button/props.md';
import Events from '@site/static/auto-generated/back-button/events.md';
import Methods from '@site/static/auto-generated/back-button/methods.md';
import Parts from '@site/static/auto-generated/back-button/parts.md';
import CustomProps from '@site/static/auto-generated/back-button/custom-props.md';
import Slots from '@site/static/auto-generated/back-button/slots.md';
import Props from '@ionic-internal/component-api/v7/back-button/props.md';
import Events from '@ionic-internal/component-api/v7/back-button/events.md';
import Methods from '@ionic-internal/component-api/v7/back-button/methods.md';
import Parts from '@ionic-internal/component-api/v7/back-button/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/back-button/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/back-button/slots.md';

<head>
<title>Back Button | ion-back-button: Custom Menu Icon for Applications</title>
Expand Down
12 changes: 6 additions & 6 deletions docs/api/backdrop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-backdrop"
---
import Props from '@site/static/auto-generated/backdrop/props.md';
import Events from '@site/static/auto-generated/backdrop/events.md';
import Methods from '@site/static/auto-generated/backdrop/methods.md';
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 Props from '@ionic-internal/component-api/v7/backdrop/props.md';
import Events from '@ionic-internal/component-api/v7/backdrop/events.md';
import Methods from '@ionic-internal/component-api/v7/backdrop/methods.md';
import Parts from '@ionic-internal/component-api/v7/backdrop/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/backdrop/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/backdrop/slots.md';

import EncapsulationPill from '@components/page/api/EncapsulationPill';

Expand Down
12 changes: 6 additions & 6 deletions docs/api/badge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-badge"
---
import Props from '@site/static/auto-generated/badge/props.md';
import Events from '@site/static/auto-generated/badge/events.md';
import Methods from '@site/static/auto-generated/badge/methods.md';
import Parts from '@site/static/auto-generated/badge/parts.md';
import CustomProps from '@site/static/auto-generated/badge/custom-props.md';
import Slots from '@site/static/auto-generated/badge/slots.md';
import Props from '@ionic-internal/component-api/v7/badge/props.md';
import Events from '@ionic-internal/component-api/v7/badge/events.md';
import Methods from '@ionic-internal/component-api/v7/badge/methods.md';
import Parts from '@ionic-internal/component-api/v7/badge/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/badge/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/badge/slots.md';

<head>
<title>Badges | ion-badge: iOS & Android App Notification Badge Icons</title>
Expand Down
12 changes: 6 additions & 6 deletions docs/api/breadcrumb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-breadcrumb"
---
import Props from '@site/static/auto-generated/breadcrumb/props.md';
import Events from '@site/static/auto-generated/breadcrumb/events.md';
import Methods from '@site/static/auto-generated/breadcrumb/methods.md';
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 Props from '@ionic-internal/component-api/v7/breadcrumb/props.md';
import Events from '@ionic-internal/component-api/v7/breadcrumb/events.md';
import Methods from '@ionic-internal/component-api/v7/breadcrumb/methods.md';
import Parts from '@ionic-internal/component-api/v7/breadcrumb/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/breadcrumb/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/breadcrumb/slots.md';

import EncapsulationPill from '@components/page/api/EncapsulationPill';

Expand Down
12 changes: 6 additions & 6 deletions docs/api/breadcrumbs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-breadcrumbs"
---
import Props from '@site/static/auto-generated/breadcrumbs/props.md';
import Events from '@site/static/auto-generated/breadcrumbs/events.md';
import Methods from '@site/static/auto-generated/breadcrumbs/methods.md';
import Parts from '@site/static/auto-generated/breadcrumbs/parts.md';
import CustomProps from '@site/static/auto-generated/breadcrumbs/custom-props.md';
import Slots from '@site/static/auto-generated/breadcrumbs/slots.md';
import Props from '@ionic-internal/component-api/v7/breadcrumbs/props.md';
import Events from '@ionic-internal/component-api/v7/breadcrumbs/events.md';
import Methods from '@ionic-internal/component-api/v7/breadcrumbs/methods.md';
import Parts from '@ionic-internal/component-api/v7/breadcrumbs/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/breadcrumbs/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/breadcrumbs/slots.md';



Expand Down
12 changes: 6 additions & 6 deletions docs/api/button.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-button"
---
import Props from '@site/static/auto-generated/button/props.md';
import Events from '@site/static/auto-generated/button/events.md';
import Methods from '@site/static/auto-generated/button/methods.md';
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 Props from '@ionic-internal/component-api/v7/button/props.md';
import Events from '@ionic-internal/component-api/v7/button/events.md';
import Methods from '@ionic-internal/component-api/v7/button/methods.md';
import Parts from '@ionic-internal/component-api/v7/button/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/button/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/button/slots.md';

<head>
<title>ion-button: Design and Style Buttons with Custom CSS Properties</title>
Expand Down
12 changes: 6 additions & 6 deletions docs/api/buttons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-buttons"
---
import Props from '@site/static/auto-generated/buttons/props.md';
import Events from '@site/static/auto-generated/buttons/events.md';
import Methods from '@site/static/auto-generated/buttons/methods.md';
import Parts from '@site/static/auto-generated/buttons/parts.md';
import CustomProps from '@site/static/auto-generated/buttons/custom-props.md';
import Slots from '@site/static/auto-generated/buttons/slots.md';
import Props from '@ionic-internal/component-api/v7/buttons/props.md';
import Events from '@ionic-internal/component-api/v7/buttons/events.md';
import Methods from '@ionic-internal/component-api/v7/buttons/methods.md';
import Parts from '@ionic-internal/component-api/v7/buttons/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/buttons/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/buttons/slots.md';

<head>
<title>ion-buttons: Toolbar Element with Named Slots for Buttons</title>
Expand Down
12 changes: 6 additions & 6 deletions docs/api/card-content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-card-content"
---
import Props from '@site/static/auto-generated/card-content/props.md';
import Events from '@site/static/auto-generated/card-content/events.md';
import Methods from '@site/static/auto-generated/card-content/methods.md';
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 Props from '@ionic-internal/component-api/v7/card-content/props.md';
import Events from '@ionic-internal/component-api/v7/card-content/events.md';
import Methods from '@ionic-internal/component-api/v7/card-content/methods.md';
import Parts from '@ionic-internal/component-api/v7/card-content/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/card-content/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/card-content/slots.md';

import EncapsulationPill from '@components/page/api/EncapsulationPill';

Expand Down
12 changes: 6 additions & 6 deletions docs/api/card-header.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-card-header"
---
import Props from '@site/static/auto-generated/card-header/props.md';
import Events from '@site/static/auto-generated/card-header/events.md';
import Methods from '@site/static/auto-generated/card-header/methods.md';
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 Props from '@ionic-internal/component-api/v7/card-header/props.md';
import Events from '@ionic-internal/component-api/v7/card-header/events.md';
import Methods from '@ionic-internal/component-api/v7/card-header/methods.md';
import Parts from '@ionic-internal/component-api/v7/card-header/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/card-header/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/card-header/slots.md';

import EncapsulationPill from '@components/page/api/EncapsulationPill';

Expand Down
12 changes: 6 additions & 6 deletions docs/api/card-subtitle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-card-subtitle"
---
import Props from '@site/static/auto-generated/card-subtitle/props.md';
import Events from '@site/static/auto-generated/card-subtitle/events.md';
import Methods from '@site/static/auto-generated/card-subtitle/methods.md';
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 Props from '@ionic-internal/component-api/v7/card-subtitle/props.md';
import Events from '@ionic-internal/component-api/v7/card-subtitle/events.md';
import Methods from '@ionic-internal/component-api/v7/card-subtitle/methods.md';
import Parts from '@ionic-internal/component-api/v7/card-subtitle/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/card-subtitle/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/card-subtitle/slots.md';

import EncapsulationPill from '@components/page/api/EncapsulationPill';

Expand Down
12 changes: 6 additions & 6 deletions docs/api/card-title.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-card-title"
---
import Props from '@site/static/auto-generated/card-title/props.md';
import Events from '@site/static/auto-generated/card-title/events.md';
import Methods from '@site/static/auto-generated/card-title/methods.md';
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 Props from '@ionic-internal/component-api/v7/card-title/props.md';
import Events from '@ionic-internal/component-api/v7/card-title/events.md';
import Methods from '@ionic-internal/component-api/v7/card-title/methods.md';
import Parts from '@ionic-internal/component-api/v7/card-title/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/card-title/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/card-title/slots.md';

import EncapsulationPill from '@components/page/api/EncapsulationPill';

Expand Down
12 changes: 6 additions & 6 deletions docs/api/card.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "ion-card"
---
import Props from '@site/static/auto-generated/card/props.md';
import Events from '@site/static/auto-generated/card/events.md';
import Methods from '@site/static/auto-generated/card/methods.md';
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 Props from '@ionic-internal/component-api/v7/card/props.md';
import Events from '@ionic-internal/component-api/v7/card/events.md';
import Methods from '@ionic-internal/component-api/v7/card/methods.md';
import Parts from '@ionic-internal/component-api/v7/card/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/card/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/card/slots.md';

import EncapsulationPill from '@components/page/api/EncapsulationPill';

Expand Down
12 changes: 6 additions & 6 deletions docs/api/checkbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
title: "ion-checkbox"
---

import Props from '@site/static/auto-generated/checkbox/props.md';
import Events from '@site/static/auto-generated/checkbox/events.md';
import Methods from '@site/static/auto-generated/checkbox/methods.md';
import Parts from '@site/static/auto-generated/checkbox/parts.md';
import CustomProps from '@site/static/auto-generated/checkbox/custom-props.md';
import Slots from '@site/static/auto-generated/checkbox/slots.md';
import Props from '@ionic-internal/component-api/v7/checkbox/props.md';
import Events from '@ionic-internal/component-api/v7/checkbox/events.md';
import Methods from '@ionic-internal/component-api/v7/checkbox/methods.md';
import Parts from '@ionic-internal/component-api/v7/checkbox/parts.md';
import CustomProps from '@ionic-internal/component-api/v7/checkbox/custom-props.md';
import Slots from '@ionic-internal/component-api/v7/checkbox/slots.md';

<head>
<title>ion-checkboxes: Ionic App Component to Select Multiple Options</title>
Expand Down
Loading