Skip to content

Commit 9c801f1

Browse files
authored
chore(docusaurus): upgrade to v3 (ionic-team#3322)
1 parent 2723b77 commit 9c801f1

File tree

258 files changed

+8010
-8801
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

258 files changed

+8010
-8801
lines changed

.prettierignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
src/theme/DocItem
2-
src/theme/DocPage
2+
src/theme/DocRoot
33
legacy-stencil-components
44
scripts/bak
55

66
docs/api
77
docs/native
8+
versioned_docs/version-v*/native
89
docs/cli/commands
910

1011
static/code/stackblitz

docs/angular/build-options.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ See the [Standalone Migration Guide](#migrating-from-modules-to-standalone) for
3131

3232
### Usage with Standalone-based Applications
3333

34-
:::caution
34+
:::warning
3535
All Ionic imports should be imported from the `@ionic/angular/standalone` submodule. This includes imports such as components, directives, providers, and types. Importing from `@ionic/angular` may pull in lazy loaded Ionic code which can interfere with treeshaking.
3636
:::
3737

@@ -203,7 +203,7 @@ Ionic Angular's standalone components use ES Modules. As a result, developers us
203203

204204
### Usage with NgModule-based Applications
205205

206-
:::caution
206+
:::warning
207207
All Ionic imports should be imported from the `@ionic/angular/standalone` submodule. This includes imports such as components, directives, providers, and types. Importing from `@ionic/angular` may pull in lazy loaded Ionic code which can interfere with treeshaking.
208208
:::
209209

docs/angular/navigation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ Here, we have a typical Angular Module setup, along with a RouterModule import,
175175

176176
## Standalone Components
177177

178-
:::caution Experimental API
178+
:::warning Experimental API
179179

180180
Standalone components is an experimental API introduced in Angular 14.x and available in Ionic 6.3 and later. This feature may change before it is stable.
181181

docs/angular/slides.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem';
1313
/>
1414
</head>
1515

16-
:::caution Looking for `ion-slides`?
16+
:::warning Looking for `ion-slides`?
1717
`ion-slides` was deprecated in v6.0.0 and removed in v7.0.0. We recommend using the Swiper.js library directly. The migration process is detailed below.
1818
:::
1919

docs/angular/virtual-scroll.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Virtual Scroll
22

3-
:::caution Looking for `ion-virtual-scroll`?
3+
:::warning Looking for `ion-virtual-scroll`?
44

55
`ion-virtual-scroll` was deprecated in v6.0.0 and removed in v7.0.0. We recommend using the `@angular/cdk` package detailed below.
66

docs/angular/your-first-app.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Here’s the finished app running on all 3 platforms:
1919
width="560"
2020
height="315"
2121
src="https://www.youtube.com/embed/0ASQ13Y1Rk4"
22-
frameborder="0"
22+
frameBorder="0"
2323
allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
24-
allowfullscreen
24+
allowFullScreen
2525
></iframe>
2626
2727
:::note

docs/components.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,8 @@ Ionic apps are made of high-level building blocks called Components, which allow
4141
</DocsCard>
4242

4343
<DocsCard header="Card" href="api/card" icon="/icons/component-card-icon.png">
44-
<p>
45-
Cards are a great way to display an important piece of content, and can contain images, buttons, text, and more.
46-
</p>
44+
<!-- prettier-ignore -->
45+
<p>Cards are a great way to display an important piece of content, and can contain images, buttons, text, and more.</p>
4746
</DocsCard>
4847

4948
<DocsCard header="Checkbox" href="api/checkbox" icon="/icons/component-checkbox-icon.png">

docs/deployment/play-store.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ keytool -genkey -v -keystore my-release-key.keystore -alias alias_name -keyalg R
105105

106106
Once that command has been ran and its prompts have been answered a file called `my-release-key.keystore` will be created in the current directory.
107107

108-
:::caution
108+
:::warning
109109
Save this file and keep it somewhere safe. If it is lost the Google Play Store will not accept updates for this app!
110110
:::
111111

docs/developer-resources/guides/first-app-v3/realtime-updates-ionic-deploy.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,11 @@ Now comes the fun part: testing out the native app on your device! For iOS, the
101101
src="https://fast.wistia.net/embed/iframe/s5v4fujv7w?videoFoam=true"
102102
title="Wistia video player"
103103
allowtransparency="true"
104-
frameborder="0"
104+
frameBorder="0"
105105
scrolling="no"
106106
class="wistia_embed"
107107
name="wistia_embed"
108-
allowfullscreen
108+
allowFullScreen
109109
mozallowfullscreen
110110
webkitallowfullscreen
111111
oallowfullscreen
@@ -130,11 +130,11 @@ In the upper right hand corner, click the Play button. Select your connected dev
130130
src="https://fast.wistia.net/embed/iframe/b2ys5v4sno?videoFoam=true"
131131
title="Wistia video player"
132132
allowtransparency="true"
133-
frameborder="0"
133+
frameBorder="0"
134134
scrolling="no"
135135
class="wistia_embed"
136136
name="wistia_embed"
137-
allowfullscreen
137+
allowFullScreen
138138
mozallowfullscreen
139139
webkitallowfullscreen
140140
oallowfullscreen

docs/index.md

+5-12
Original file line numberDiff line numberDiff line change
@@ -139,18 +139,11 @@ Ionic is actively developed and maintained full-time by a core team, and its eco
139139

140140
There are millions of Ionic developers in over 200 countries worldwide. Here are some ways to join:
141141

142-
- <a href="https://forum.ionicframework.com/" target="_blank">
143-
Forum:
144-
</a> A great place for asking questions and sharing ideas.
145-
- <a href="https://twitter.com/ionicframework" target="_blank">
146-
Twitter:
147-
</a> Where we post updates and share content from the Ionic community.
148-
- <a href="https://github.com/ionic-team/ionic" target="_blank">
149-
GitHub:
150-
</a> For reporting bugs or requesting new features, create an issue here. PRs welcome!
151-
- <a href="https://ionicframework.com/contributors" target="_blank">
152-
Content authoring:
153-
</a> Write a technical blog or share your story with the Ionic community.
142+
<!-- prettier-ignore -->
143+
- <a href="https://forum.ionicframework.com/" target="_blank">Forum:</a> A great place for asking questions and sharing ideas.
144+
- <a href="https://twitter.com/ionicframework" target="_blank">Twitter:</a> Where we post updates and share content from the Ionic community.
145+
- <a href="https://github.com/ionic-team/ionic" target="_blank">GitHub:</a> For reporting bugs or requesting new features, create an issue here. PRs welcome!
146+
- <a href="https://ionicframework.com/contributors" target="_blank">Content authoring:</a> Write a technical blog or share your story with the Ionic community.
154147

155148
## License
156149

docs/react.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ import DocsCards from '@components/global/DocsCards';
2020

2121
<PageStyles>
2222

23-
<div class='flex main-flex'>
24-
<div class="pull-left">
23+
<div className='flex main-flex'>
24+
<div className="pull-left">
2525
<h1>One Codebase <br/> Any Platform <br/> <strong>Just React</strong></h1>
2626

2727
- ✓ 100+ mobile optimized React UI components
@@ -32,8 +32,8 @@ import DocsCards from '@components/global/DocsCards';
3232

3333
</div>
3434

35-
<div class="pull-right">
36-
<img src={require('@site/static/img/frameworks/react-logo.png').default} />
35+
<div className="pull-right">
36+
<img src="/docs/img/frameworks/react-logo.png" />
3737
</div>
3838
</div>
3939

@@ -43,9 +43,9 @@ Ionic React is native React version of Ionic Framework, the free, open source SD
4343

4444
It's everything you need to ship award-winning apps for any platform, with React.
4545

46-
<div class="flex" >
46+
<div className="flex" >
4747

48-
<div class="pull-left">
48+
<div className="pull-left">
4949

5050
## Amazing Design
5151

@@ -55,15 +55,15 @@ Choose from over 100 beautiful, mobile-ready UI components, animations, and gest
5555

5656
</div>
5757

58-
<div class="pull-right">
58+
<div className="pull-right">
5959
<img src="/docs/icons/feature-guide-components-icon.png" />
6060
</div>
6161

6262
</div>
6363

64-
<div class="flex reverse" >
64+
<div className="flex reverse" >
6565

66-
<div class="pull-left">
66+
<div className="pull-left">
6767

6868
## Familiar tooling
6969

@@ -72,40 +72,40 @@ Compatible with React version 16.8 and above.
7272

7373
</div>
7474

75-
<div class="pull-right">
76-
<img src={require('@site/static/img/frameworks/react-cli.png').default} class="cli" />
75+
<div className="pull-right">
76+
<img src="/docs/img/frameworks/react-cli.png" className="cli" />
7777
</div>
7878

7979
</div>
8080

81-
<div class="flex">
81+
<div className="flex">
8282

83-
<div class="pull-left">
83+
<div className="pull-left">
8484

8585
## More than mobile
8686

8787
Deploy your Ionic React projects to native iOS, Android, Electron, and the web as a Progressive Web App, using [Capacitor](https://capacitorjs.com), a modern native runtime. All with one shared codebase.
8888

8989
</div>
9090

91-
<div class="pull-right">
92-
<img src={require('@site/static/img/native-platforms/group-shot.png').default} />
91+
<div className="pull-right">
92+
<img src="/docs/img/native-platforms/group-shot.png" />
9393
</div>
9494

9595
</div>
9696

97-
<div class="flex reverse">
97+
<div className="flex reverse">
9898

99-
<div class="pull-left">
99+
<div className="pull-left">
100100

101101
## Just React
102102

103103
At the end of the day, it's just React. Ionic React uses open web standards and built-in browser capabilities, so it's compatible with any of the millions of web libraries out there.
104104

105105
</div>
106106

107-
<div class="pull-right">
108-
<img src={require('@site/static/img/frameworks/react.svg').default} />
107+
<div className="pull-right">
108+
<img src="/docs/img/frameworks/react.svg" />
109109
</div>
110110

111111
</div>

docs/react/slides.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ title: Migrating From IonSlides to Swiper.js
1010
/>
1111
</head>
1212

13-
:::caution Looking for `IonSlides`?
13+
:::warning Looking for `IonSlides`?
1414

1515
`IonSlides` was deprecated in v6.0.0 and removed in v7.0.0. We recommend using the Swiper.js library directly. The migration process is detailed below.
1616

docs/react/virtual-scroll.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Virtual Scroll
22

3-
:::caution Looking for `ion-virtual-scroll`?
3+
:::warning Looking for `ion-virtual-scroll`?
44

55
`ion-virtual-scroll` was deprecated in v6.0.0 and removed in v7.0.0. We recommend using the Virtuoso package detailed below.
66

docs/react/your-first-app.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Here’s the finished app running on all 3 platforms:
1919
width="560"
2020
height="315"
2121
src="https://www.youtube.com/embed/0ASQ13Y1Rk4"
22-
frameborder="0"
22+
frameBorder="0"
2323
allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
24-
allowfullscreen
24+
allowFullScreen
2525
></iframe>
2626
2727
## What We'll Build

docs/troubleshooting/debugging.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ title: Debugging
1414
width="560"
1515
height="315"
1616
src="https://www.youtube.com/embed/akh6V6Yw1lw"
17-
frameborder="0"
17+
frameBorder="0"
1818
allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
19-
allowfullscreen
19+
allowFullScreen
2020
></iframe>
2121
2222
## Live Reload

docs/troubleshooting/native.md

+6-12
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,8 @@ Running an app on an iOS device requires a provisioning profile. If a provisioni
2424
2525
For Cordova, open the `config.xml` file and modify the `id` attribute of the root element, `<widget>`. See [the Cordova documentation](https://cordova.apache.org/docs/en/latest/config_ref/#widget) for more information.
2626
27-
2. <strong>
28-
Open the project in <b>Xcode</b>.
29-
</strong>
27+
<!-- prettier-ignore -->
28+
2. <strong>Open the project in <b>Xcode</b>.</strong>
3029
3130
For Capacitor, run the following to open the app in Xcode:
3231
@@ -36,18 +35,13 @@ Running an app on an iOS device requires a provisioning profile. If a provisioni
3635
3736
For Cordova, open Xcode. Use **File** &raquo; **Open** and locate the app. Open the app's `platforms/ios` directory.
3837
39-
3. <strong>
40-
In <b>Project navigator</b>, select the project root to open the project editor. Under the **Identity** section,
41-
verify that the Package ID that was set matches the Bundle Identifier.
42-
</strong>
38+
<!-- prettier-ignore -->
39+
3. <strong>In <b>Project navigator</b>, select the project root to open the project editor. Under the **Identity** section, verify that the Package ID that was set matches the Bundle Identifier.</strong>
4340
4441
![Xcode Identity Setup](/img/running/ios-xcode-identity-setup.png)
4542
46-
4. <strong>
47-
In the same project editor, under the <b>Signing</b> section, ensure <b>Automatically manage signing</b> is
48-
enabled.
49-
</strong> Then, select a Development Team. Given a Development Team, Xcode will attempt to automatically prepare provisioning
50-
and signing.
43+
<!-- prettier-ignore -->
44+
4. <strong>In the same project editor, under the <b>Signing</b> section, ensure <b>Automatically manage signing</b> is enabled.</strong> Then, select a Development Team. Given a Development Team, Xcode will attempt to automatically prepare provisioning and signing.
5145
5246
![Xcode Signing Setup](/img/running/ios-xcode-signing-setup.png)
5347

docs/updating/4-0.md

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
title: Updating to v4
33
---
44

5+
import Tabs from '@theme/Tabs';
6+
import TabItem from '@theme/TabItem';
7+
58
# Updating to Ionic 4
69

710
## Updating from Ionic 3 to 4

docs/vue/slides.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ title: Migrating From ion-slides to Swiper.js
1010
/>
1111
</head>
1212

13-
:::caution Looking for `ion-slides`?
13+
:::warning Looking for `ion-slides`?
1414
`ion-slides` was deprecated in v6.0.0 and removed in v7.0.0. We recommend using the Swiper.js library directly. The migration process is detailed below.
1515
:::
1616

docs/vue/virtual-scroll.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Virtual Scroll
22

3-
:::caution Looking for `ion-virtual-scroll`?
3+
:::warning Looking for `ion-virtual-scroll`?
44

55
`ion-virtual-scroll` was deprecated in v6.0.0 and removed in v7.0.0. We recommend using a Vue library to accomplish this. We outline one approach using `vue-virtual-scroller` below.
66

docs/vue/your-first-app.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Here’s the finished app running on all 3 platforms:
1919
width="560"
2020
height="315"
2121
src="https://www.youtube.com/embed/0ASQ13Y1Rk4"
22-
frameborder="0"
22+
frameBorder="0"
2323
allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
24-
allowfullscreen
24+
allowFullScreen
2525
></iframe>
2626
2727
## What We'll Build

docusaurus.config.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ module.exports = {
3838
if (locale != 'en') {
3939
return 'https://crowdin.com/project/ionic-docs';
4040
}
41+
let match;
4142
if ((match = docPath.match(/api\/(.*)\.md/)) != null) {
4243
return `https://github.com/ionic-team/ionic-docs/tree/main/docs/api/${match[1]}.md`;
4344
}
@@ -275,7 +276,7 @@ module.exports = {
275276
},
276277
prism: {
277278
theme: { plain: {}, styles: [] },
278-
// https://github.com/FormidableLabs/prism-react-renderer/blob/5a1c93592c6475fb230bfcb8a9666b72b331638b/packages/generate-prism-languages/index.ts#L9-L24
279+
// https://github.com/FormidableLabs/prism-react-renderer/blob/e6d323332b0363a633407fabab47b608088e3a4d/packages/generate-prism-languages/index.ts#L9-L25
279280
additionalLanguages: ['shell-session', 'http'],
280281
},
281282
algolia: {

0 commit comments

Comments
 (0)