Skip to content

Commit bb2d9e4

Browse files
committed
chore(docs): migrate HTML comments to MDX comment syntax
1 parent d2013d3 commit bb2d9e4

35 files changed

Lines changed: 97 additions & 131 deletions

docs/angular/performance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ For more information on how Angular manages change propagation with `ngFor` see
5656

5757
## From the Community
5858

59-
<!-- cspell:disable -->
59+
{/* cspell:disable */}
6060

6161
[High Performance Animations in Ionic](https://www.joshmorony.com/high-performance-animations-in-ionic/) - Josh Morony
6262

@@ -66,7 +66,7 @@ For more information on how Angular manages change propagation with `ngFor` see
6666

6767
[Ionic Framework is Fast (But Your Code Might Not Be)](https://www.joshmorony.com/ionic-framework-is-fast-but-your-code-might-not-be/) - Josh Morony
6868

69-
<!-- cspell:enable -->
69+
{/* cspell:enable */}
7070

7171
:::note
7272
Do you have a guide you'd like to share? Click the _Edit this page_ button below.

docs/api/buttons.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ This feature is only available for iOS.
6262

6363
:::
6464

65-
<!-- Reuse the playground from the Title directory -->
65+
{/* Reuse the playground from the Title directory */}
6666
import CollapsibleLargeTitleButtons from '@site/static/usage/v8/title/collapsible-large-title/buttons/index.md';
6767

6868
<CollapsibleLargeTitleButtons />

docs/api/datetime-button.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,12 @@ import FormatOptions from '@site/static/usage/v8/datetime-button/format-options/
4747

4848
`ion-datetime-button` must be associated with a mounted `ion-datetime` instance. As a result, [Inline Modals](./modal#inline-modals-recommended) and [Inline Popovers](./popover#inline-popovers) with the `keepContentsMounted` property set to `true` must be used.
4949

50-
<!--
51-
## Customization
52-
53-
TODO
54-
55-
### Buttons
56-
57-
TODO
58-
59-
### Theming
60-
61-
TODO
62-
-->
50+
{/* ## Customization */}
51+
{/* TODO */}
52+
{/* ### Buttons */}
53+
{/* TODO */}
54+
{/* ### Theming */}
55+
{/* TODO */}
6356

6457
## Properties
6558
<Props />

docs/api/item.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -179,19 +179,12 @@ import DetailArrows from '@site/static/usage/v8/item/detail-arrows/index.md';
179179
<DetailArrows />
180180

181181

182-
<!--
183-
184-
TODO add this functionality back as a css variable
185-
186-
This feature is not enabled by default on clickable items for the `md` mode, but it can be enabled by setting the following CSS variable:
187-
188-
```css
189-
--item-detail-push-show: true;
190-
```
191-
192-
See the [theming documentation](/docs/theming/css-variables) for more information.
193-
194-
-->
182+
{/* TODO add this functionality back as a css variable */}
183+
{/* This feature is not enabled by default on clickable items for the `md` mode, but it can be enabled by setting the following CSS variable: */}
184+
{/* ```css */}
185+
{/* --item-detail-push-show: true; */}
186+
{/* ``` */}
187+
{/* See the [theming documentation](/docs/theming/css-variables) for more information. */}
195188

196189

197190
## Item Lines

docs/api/progress-bar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ import Indeterminate from '@site/static/usage/v8/progress-bar/indeterminate/inde
4848

4949
## Progress Bars in Toolbars
5050

51-
<!-- Reuse the playground from the Toolbar directory -->
51+
{/* Reuse the playground from the Toolbar directory */}
5252
import Toolbar from '@site/static/usage/v8/toolbar/progress-bars/index.md';
5353

5454
<Toolbar />

docs/api/searchbar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ import CancelButton from '@site/static/usage/v8/searchbar/cancel-button/index.md
5858

5959
Searchbars are styled to look native when placed inside of a toolbar. In iOS, searchbars should be placed in their own toolbar, under a toolbar that contains the page title. In Material Design, searchbars are either persistently displayed in their own toolbar, or expand over a toolbar containing the page title.
6060

61-
<!-- Reuse the playground from the Toolbar directory -->
61+
{/* Reuse the playground from the Toolbar directory */}
6262
import Toolbar from '@site/static/usage/v8/toolbar/searchbars/index.md';
6363

6464
<Toolbar />

docs/api/segment-content.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ for more information on how to use segment contents.
2727
Each `ion-segment-content` needs a unique `id` attribute. This will be used to link the segment content to a segment button via the button's
2828
[contentId property](./segment-button.md#properties).
2929

30-
<!-- Reuse swipeable segments playground -->
30+
{/* Reuse swipeable segments playground */}
3131

3232
import Swipeable from '@site/static/usage/v8/segment/swipeable/index.md';
3333

docs/api/segment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ import Scrollable from '@site/static/usage/v8/segment/scrollable/index.md';
4343

4444
## Segments in Toolbars
4545

46-
<!-- Reuse the playground from the Toolbar directory -->
46+
{/* Reuse the playground from the Toolbar directory */}
4747
import Toolbar from '@site/static/usage/v8/toolbar/segments/index.md';
4848

4949
<Toolbar />

docs/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Be sure to run `ionic <command> --help` in your project directory.
3737
For some commands, such as `ionic serve`, the help documentation is contextual to the type of your project, e.g. React vs Angular.
3838
:::
3939

40-
<!-- TODO: image? -->
40+
{/* TODO: image? */}
4141

4242
## Architecture
4343

docs/core-concepts/what-are-progressive-web-apps.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: Progressive Web Apps
1111
/>
1212
</head>
1313

14-
<!-- TOC goes here -->
14+
{/* TOC goes here */}
1515

1616
### The web...but better
1717

@@ -47,15 +47,15 @@ To be considered a Progressive Web App, your app must be:
4747

4848
- Linkable - Easily share via URL and not require complex installation.
4949

50-
<!-- cspell:disable -->
50+
{/* cspell:disable */}
5151

5252
<em>
5353
<a href="https://addyosmani.com/blog/getting-started-with-progressive-web-apps/" target="_blank">
5454
Addy Osmani: Progressive web apps
5555
</a>
5656
</em>
5757

58-
<!-- cspell:enable -->
58+
{/* cspell:enable */}
5959

6060
There is a lot here, but it boils down to a few points for Ionic apps.
6161

0 commit comments

Comments
 (0)