Skip to content

chore(docusaurus): enable faster #4619

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

Open
thetaPC wants to merge 6 commits into
base: main
Choose a base branch
from
Open

chore(docusaurus): enable faster #4619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
da4a532
chore(docusaurus): enable faster
thetaPC Aug 6, 2026
df1d32f
chore: retrigger checks
thetaPC Aug 7, 2026
b24d1ea
fix(glossary): remove stray space before punctuation in v7 definitions
thetaPC Aug 10, 2026
504f53d
docs(slides): more descriptive link
thetaPC Aug 10, 2026
074d705
chore(prettier): explain why the glossaries are excluded from formatting
thetaPC Aug 10, 2026
dfa6d9c
fix(coc): autolink the contact email instead of wrapping it in an anchor
thetaPC Aug 10, 2026
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
5 changes: 5 additions & 0 deletions .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,12 @@ docs/api
docs/native
versioned_docs/version-v*/native
docs/cli/commands
# Each definition in these files is one line of prose inside a JSX <section>.
# Prettier's mdx parser reflows those children and moves link text onto its own
# line, which MDX then wraps in a paragraph, rendering invalid HTML such as
# <a><p>Android SDK</p></a>. Formatting these files reintroduces that markup.
docs/reference/glossary.md
versioned_docs/version-v*/reference/glossary.md

@ShaneK ShaneK Aug 10, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This entry is doing more work than it looks. The v7 glossary was prettier-clean before this PR and the edit makes it dirty, so CI needs the ignore. Prettier wants to move the link text onto its own lines, which is the exact shape that produced the nested paragraphs you're removing, so the entry is the right call. Worth a line in the description though if that's possible, since as written it reads like a suppression.

@thetaPC thetaPC Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

074d705


static/code/stackblitz

Expand Down
3 changes: 0 additions & 3 deletions babel.config.js
View file
Open in desktop

This file was deleted.

16 changes: 8 additions & 8 deletions docs/angular/slides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ From there, we just have to replace `ion-slides` elements with `swiper-container

By default, make sure you import the `register` function from `swiper/element/bundle`. This uses the bundled version of Swiper, which automatically includes all modules and stylesheets needed to run Swiper's various features.

If you would like to use the Core version instead, which does not include additional modules automatically, see <a href="https://swiperjs.com/element#core-version-and-modules" target="_blank" rel="noopener noreferrer">https://swiperjs.com/element#core-version-and-modules</a>. The rest of this migration guide will assume you are using the bundled version.
If you would like to use the Core version instead, which does not include additional modules automatically, refer to <a href="https://swiperjs.com/element#core-version-and-modules" target="_blank" rel="noopener noreferrer">Swiper's core version and modules documentation</a>. The rest of this migration guide will assume you are using the bundled version.

## Swiping with Style

Expand All @@ -93,7 +93,7 @@ If you were using the CSS custom properties found on `ion-slides`, below is a li
| `--scroll-bar-background` | `--swiper-scrollbar-bg-color` |
| `--scroll-bar-background-active` | `--swiper-scrollbar-drag-bg-color` |

For additional custom CSS, because Swiper Element uses Shadow DOM encapsulation, styles will need to be injected into the Shadow DOM scope. See <a href="https://swiperjs.com/element#injecting-styles" target="_blank" rel="noopener noreferrer">https://swiperjs.com/element#injecting-styles</a> for instructions.
For additional custom CSS, because Swiper Element uses Shadow DOM encapsulation, styles will need to be injected into the Shadow DOM scope. Refer to <a href="https://swiperjs.com/element#injecting-styles" target="_blank" rel="noopener noreferrer">Swiper's guide on injecting styles</a> for instructions.

### Additional `ion-slides` Styles

Expand Down Expand Up @@ -227,7 +227,7 @@ Below is a full list of property changes when going from `ion-slides` to Swiper
| pager | Use the `pagination` property instead. |

:::note
All properties available in Swiper Element can be found at <a href="https://swiperjs.com/swiper-api#parameters" target="_blank" rel="noopener noreferrer">https://swiperjs.com/swiper-api#parameters</a>.
All properties available in Swiper Element can be found in the <a href="https://swiperjs.com/swiper-api#parameters" target="_blank" rel="noopener noreferrer">Swiper API parameters documentation</a>.
:::

## Events
Expand Down Expand Up @@ -276,7 +276,7 @@ Below is a full list of event name changes when going from `ion-slides` to Swipe
| `ionSlidesDidLoad` | `swiperinit` |

:::note
All events available in Swiper Element can be found at <a href="https://swiperjs.com/swiper-api#events" target="_blank" rel="noopener noreferrer">https://swiperjs.com/swiper-api#events</a> and should be lowercased and prefixed with the word `swiper`.
All events available in Swiper Element can be found in the <a href="https://swiperjs.com/swiper-api#events" target="_blank" rel="noopener noreferrer">Swiper API events documentation</a> and should be lowercased and prefixed with the word `swiper`.
:::

## Methods
Expand Down Expand Up @@ -328,7 +328,7 @@ Below is a full list of method changes when going from `ion-slides` to Swiper El
| `stopAutoplay()` | Use the `autoplay` property instead. |

:::note
All methods and properties available on the Swiper instance can be found at <a href="https://swiperjs.com/swiper-api#methods-and-properties" target="_blank" rel="noopener noreferrer">https://swiperjs.com/swiper-api#methods-and-properties</a>.
All methods and properties available on the Swiper instance can be found in the <a href="https://swiperjs.com/swiper-api#methods-and-properties" target="_blank" rel="noopener noreferrer">Swiper API methods and properties documentation</a>.
:::

## Effects
Expand All @@ -340,7 +340,7 @@ Effects such as Cube or Fade can be used in Swiper Element with no additional im
```

:::note
For more information on effects in Swiper, please see <a href="https://swiperjs.com/swiper-api#fade-effect" target="_blank" rel="noopener noreferrer">https://swiperjs.com/swiper-api#fade-effect</a>.
For more information on effects in Swiper, please refer to the <a href="https://swiperjs.com/swiper-api#fade-effect" target="_blank" rel="noopener noreferrer">Swiper API fade effect documentation</a>.
:::

## Wrap Up
Expand All @@ -361,6 +361,6 @@ If you are running into issues with the migration, please create a post on the [

Before opening an issue, please consider creating a post on the <a href="https://github.com/nolimits4web/swiper/discussions" target="_blank" rel="noopener noreferrer">Swiper Discussion Board</a> or the <a href="https://forum.ionicframework.com" target="_blank">Ionic Forum</a> to see if your issue can be resolved by the community.

If you are running into problems with the Swiper library, new bugs should be filed on the Swiper repo: <a href="https://github.com/nolimits4web/swiper/issues" target="_blank" rel="noopener noreferrer">https://github.com/nolimits4web/swiper/issues</a>
If you are running into problems with the Swiper library, new bugs should be filed on the <a href="https://github.com/nolimits4web/swiper/issues" target="_blank" rel="noopener noreferrer">Swiper issue tracker</a>.

If you are running into problems with the `IonicSlides` module, new bugs should be filed on the Ionic Framework repo: <a href="https://github.com/ionic-team/ionic-framework/issues" target="_blank" rel="noopener noreferrer">https://github.com/ionic-team/ionic-framework/issues</a>
If you are running into problems with the `IonicSlides` module, new bugs should be filed on the <a href="https://github.com/ionic-team/ionic-framework/issues" target="_blank" rel="noopener noreferrer">Ionic Framework issue tracker</a>.
16 changes: 5 additions & 11 deletions docs/components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,7 @@ Ionic apps are made of high-level building blocks called Components, which allow
</DocsCard>

<DocsCard header="Card" href="api/card" icon="/icons/component-card-icon.png">
<p>
Cards are a great way to display an important piece of content, and can contain images, buttons, text, and more.
</p>
Cards are a great way to display an important piece of content, and can contain images, buttons, text, and more.
</DocsCard>

<DocsCard header="Checkbox" href="api/checkbox" icon="/icons/component-checkbox-icon.png">
Expand Down Expand Up @@ -91,21 +89,17 @@ Ionic apps are made of high-level building blocks called Components, which allow
</DocsCard>

<DocsCard header="Item" href="api/item" img="/icons/feature-component-item-icon.png">
<p>
Items are elements that can contain text, icons, avatars, images, inputs, and any other native or custom elements.
Items can be swiped, deleted, reordered, edited, and more.
</p>
Items are elements that can contain text, icons, avatars, images, inputs, and any other native or custom elements.
Items can be swiped, deleted, reordered, edited, and more.
</DocsCard>

<DocsCard header="List" href="api/list" icon="/icons/component-lists-icon.png">
<p>Lists can display rows of information, such as a contact list, playlist, or menu.</p>
</DocsCard>

<DocsCard header="Media" href="api/avatar" icon="/icons/component-media-icon.png">
<p>
A collection of media components, including avatars, icons, images, and thumbnails, designed to enhance visual
content.
</p>
A collection of media components, including avatars, icons, images, and thumbnails, designed to enhance visual
content.
</DocsCard>

<DocsCard header="Menu" href="api/menu" icon="/icons/component-menu-icon.png">
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/coc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ We promise to extend courtesy and respect to everyone involved in this project r

If any member of the community violates this code of conduct, the maintainers of the Ionic project may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate.

If you are subject to or witness unacceptable behavior, or have any other concerns, please email us at <a href="mailto:devrel@ionic.io">devrel@ionic.io</a>.
If you are subject to or witness unacceptable behavior, or have any other concerns, please email us at devrel@ionic.io.

Please click <a href="https://ionic.io/code-of-conduct" target="_blank" rel="noopener">here</a> to review to Ionic's full code of conduct.
4 changes: 1 addition & 3 deletions docs/javascript/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,7 @@ $ npm run dev █
href="https://developer.mozilla.org/en-US/docs/Web/JavaScript"
icon="/icons/logo-javascript-icon.png"
>
<p>
Learn more about JavaScript's core concepts, tools, and best practices from the official JavaScript documentation.
</p>
Learn more about JavaScript's core concepts, tools, and best practices from the official JavaScript documentation.
</DocsCard>

<DocsCard header="Navigation" href="/docs/api/router" icon="/icons/component-navigation-icon.png">
Expand Down
12 changes: 6 additions & 6 deletions docs/react/slides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ export default Home;
```

:::note
See <a href="https://swiperjs.com/react#usage" target="_blank" rel="noopener noreferrer">https://swiperjs.com/react#usage</a> for a full list of modules.
Refer to <a href="https://swiperjs.com/react#usage" target="_blank" rel="noopener noreferrer">Swiper's React usage documentation</a> for a full list of modules.
:::

## The IonicSlides Module
Expand Down Expand Up @@ -356,7 +356,7 @@ Below is a full list of property changes when going from `IonSlides` to Swiper R
| scrollbar | You can continue to use the `scrollbar` property, just be sure to install the Scrollbar module first. |

:::note
All properties available in Swiper React can be found at <a href="https://swiperjs.com/react#swiper-props" target="_blank" rel="noopener noreferrer">https://swiperjs.com/react#swiper-props</a>.
All properties available in Swiper React can be found in the <a href="https://swiperjs.com/react#swiper-props" target="_blank" rel="noopener noreferrer">Swiper React props documentation</a>.
:::

## Events
Expand Down Expand Up @@ -413,7 +413,7 @@ Below is a full list of event name changes when going from `IonSlides` to Swiper
| `onIonSlidesDidLoad` | `onInit` |

:::note
All events available in Swiper can be found at <a href="https://swiperjs.com/swiper-api#events" target="_blank" rel="noopener noreferrer">https://swiperjs.com/swiper-api#events</a>.
All events available in Swiper can be found in the <a href="https://swiperjs.com/swiper-api#events" target="_blank" rel="noopener noreferrer">Swiper API events documentation</a>.
:::

## Methods
Expand Down Expand Up @@ -545,7 +545,7 @@ export default Home;
```

:::note
For more information on effects in Swiper, please see <a href="https://swiperjs.com/react#effects" target="_blank" rel="noopener noreferrer">https://swiperjs.com/react#effects</a>.
For more information on effects in Swiper, please refer to the <a href="https://swiperjs.com/react#effects" target="_blank" rel="noopener noreferrer">Swiper React effects documentation</a>.
:::

## Wrap Up
Expand All @@ -566,6 +566,6 @@ If you are running into issues with the migration, please create a post on the [

Before opening an issue, please consider creating a post on the <a href="https://github.com/nolimits4web/swiper/discussions" target="_blank" rel="noopener noreferrer">Swiper Discussion Board</a> or the <a href="https://forum.ionicframework.com" target="_blank">Ionic Forum</a> to see if your issue can be resolved by the community.

If you are running into problems with the Swiper library, new bugs should be filed on the Swiper repo: <a href="https://github.com/nolimits4web/swiper/issues" target="_blank" rel="noopener noreferrer">https://github.com/nolimits4web/swiper/issues</a>
If you are running into problems with the Swiper library, new bugs should be filed on the <a href="https://github.com/nolimits4web/swiper/issues" target="_blank" rel="noopener noreferrer">Swiper issue tracker</a>.

If you are running into problems with the `IonicSlides` module, new bugs should be filed on the Ionic Framework repo: <a href="https://github.com/ionic-team/ionic-framework/issues" target="_blank" rel="noopener noreferrer">https://github.com/ionic-team/ionic-framework/issues</a>
If you are running into problems with the `IonicSlides` module, new bugs should be filed on the <a href="https://github.com/ionic-team/ionic-framework/issues" target="_blank" rel="noopener noreferrer">Ionic Framework issue tracker</a>.
Loading
Loading