Skip to content

Commit 197b3b9

Browse files
committed
Replace blockquote with admonition
1 parent 1f81dee commit 197b3b9

File tree

108 files changed

+654
-238
lines changed

Some content is hidden

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

108 files changed

+654
-238
lines changed

docs/angular/lifecycle.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ Ionic embraces the life cycle events provided by Angular. The two Angular events
2121

2222
For more info on the Angular Component Life Cycle events, visit their [component lifecycle docs](https://angular.io/guide/lifecycle-hooks).
2323

24-
> Components that use `ion-nav` or `ion-router-outlet` should not use the `OnPush` change detection strategy. Doing so will prevent lifecycle hooks such as `ngOnInit` from firing. Additionally, asynchronous state changes may not render properly.
24+
:::note
25+
Components that use `ion-nav` or `ion-router-outlet` should not use the `OnPush` change detection strategy. Doing so will prevent lifecycle hooks such as `ngOnInit` from firing. Additionally, asynchronous state changes may not render properly.
26+
:::
2527

2628
## Ionic Page Events
2729

docs/angular/navigation.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,9 @@ export class LoginComponent {
110110

111111
Both options provide the same navigation mechanism, just fitting different use cases.
112112

113-
> A note on navigation with relative URLs: Currently, to support multiple navigation stacks, relative URLs are something not supported
113+
:::note
114+
A note on navigation with relative URLs: Currently, to support multiple navigation stacks, relative URLs are something not supported
115+
:::
114116

115117
## Lazy loading routes
116118

@@ -151,7 +153,9 @@ import { LoginComponent } from './login.component';
151153
})
152154
```
153155

154-
> We're excluding some additional content and only including the necessary parts.
156+
:::note
157+
We're excluding some additional content and only including the necessary parts.
158+
:::
155159

156160

157161
Here, we have a typical Angular Module setup, along with a RouterModule import, but we're now using `forChild` and declaring the component in that setup. With this setup, when we run our build, we will produce separate chunks for both the app component, the login component, and the detail component.

docs/angular/performance.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,6 @@ For more information on how Angular manages change propagation with `ngFor` see
5454

5555
[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
5656

57-
> Do you have a guide you'd like to share? Click the *Edit this page* button below.
57+
:::note
58+
Do you have a guide you'd like to share? Click the *Edit this page* button below.
59+
:::

docs/angular/pwa.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,14 @@ $ ng add @angular/pwa
1818

1919
Once this package has been added run `ionic build --prod` and the `www` directory will be ready to deploy as a PWA.
2020

21-
> By default, the `@angular/pwa` package comes with the Angular logo for the app icons. Be sure to update the manifest to use the correct app name and also replace the icons.
21+
:::note
22+
By default, the `@angular/pwa` package comes with the Angular logo for the app icons. Be sure to update the manifest to use the correct app name and also replace the icons.
23+
:::
2224

2325

24-
> Note: Features like Service Workers and many JavaScript APIs (such as geolocation) require the app be hosted in a secure context. When deploying an app through a hosting service, be aware that HTTPS will be required to take full advantage of Service Workers.
26+
:::note
27+
Features like Service Workers and many JavaScript APIs (such as geolocation) require the app be hosted in a secure context. When deploying an app through a hosting service, be aware that HTTPS will be required to take full advantage of Service Workers.
28+
:::
2529

2630
## Service Worker configuration
2731

@@ -75,7 +79,9 @@ Next, in a Terminal, install the Firebase CLI:
7579
$ npm install -g firebase-tools
7680
```
7781

78-
> Note: If it's the first time you use firebase-tools, login to your Google account with `firebase login` command.
82+
:::note
83+
If it's the first time you use firebase-tools, login to your Google account with `firebase login` command.
84+
:::
7985

8086
With the Firebase CLI installed, run `firebase init` within your Ionic project. The CLI prompts:
8187

@@ -85,7 +91,9 @@ With the Firebase CLI installed, run `firebase init` within your Ionic project.
8591

8692
**"What do you want to use as your public directory?"** Enter "www".
8793

88-
> Note: Answering these next two questions will ensure that routing, hard reload, and deep linking work in the app:
94+
:::note
95+
Answering these next two questions will ensure that routing, hard reload, and deep linking work in the app:
96+
:::
8997

9098
**Configure as a single-page app (rewrite all urls to /index.html)?"** Enter "Yes".
9199

docs/angular/slides.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,9 @@ export class SlidesExample {
138138
</swiper>
139139
```
140140

141-
> Importing `swiper-bundle.min.css` imports styles for all modules. When using the SCSS or Less styles, you will need to import the styles for each module. See <a href="https://swiperjs.com/angular#styles" target="_blank" rel="noopener noreferrer">https://swiperjs.com/angular#styles</a> for a full list of stylesheets.
141+
:::note
142+
Importing `swiper-bundle.min.css` imports styles for all modules. When using the SCSS or Less styles, you will need to import the styles for each module. See <a href="https://swiperjs.com/angular#styles" target="_blank" rel="noopener noreferrer">https://swiperjs.com/angular#styles</a> for a full list of stylesheets.
143+
:::
142144
## Properties
143145

144146
Swiper options are provided as props directly on the `<swiper>` component rather than via the `options` object in `ion-slides`.

docs/angular/your-first-app.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ Here’s the finished app running on all 3 platforms:
1010

1111
<iframe width="560" height="315" src="https://www.youtube.com/embed/0ASQ13Y1Rk4" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
1212

13-
> Looking for the previous version of this guide that covered Ionic 4 and Cordova? [See here.](../developer-resources/guides/first-app-v4/intro.md)
13+
:::note
14+
Looking for the previous version of this guide that covered Ionic 4 and Cordova? [See here.](../developer-resources/guides/first-app-v4/intro.md)
15+
:::
1416

1517
## What We'll Build
1618

@@ -35,15 +37,19 @@ Download and install these right away to ensure an optimal Ionic development exp
3537
## Install Ionic Tooling
3638
Run the following in the command line terminal to install the Ionic CLI (`ionic`), `native-run`, used to run native binaries on devices and simulators/emulators, and `cordova-res`, used to generate native app icons and splash screens:
3739

38-
> To open a terminal in Visual Studio Code, go to Terminal -> New Terminal.
40+
:::note
41+
To open a terminal in Visual Studio Code, go to Terminal -> New Terminal.
42+
:::
3943

4044
```shell
4145
$ npm install -g @ionic/cli native-run cordova-res
4246
```
4347

44-
> The `-g` option means _install globally_. When packages are installed globally, `EACCES` permission errors can occur.
45-
>
46-
> Consider setting up npm to operate globally without elevated permissions. See [Resolving Permission Errors](../developing/tips.md#resolving-permission-errors) for more information.
48+
:::note
49+
The `-g` option means _install globally_. When packages are installed globally, `EACCES` permission errors can occur.
50+
51+
Consider setting up npm to operate globally without elevated permissions. See [Resolving Permission Errors](../developing/tips.md#resolving-permission-errors) for more information.
52+
:::
4753

4854
## Create an App
4955
Next, create an Ionic Angular app that uses the “Tabs” starter template and adds Capacitor for native functionality:

docs/angular/your-first-app/6-deploying-mobile.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ $ ionic cap sync
3939

4040
## iOS Deployment
4141

42-
> To build an iOS app, you’ll need a Mac computer.
42+
:::note
43+
To build an iOS app, you’ll need a Mac computer.
44+
:::
4345

4446
Capacitor iOS apps are configured and managed through Xcode (Apple’s iOS/Mac IDE), with dependencies managed by [CocoaPods](https://cocoapods.org/). Before running this app on an iOS device, there's a couple of steps to complete.
4547

docs/cli.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,11 @@ $ ionic <command> --help
2626
$ ionic <command> <subcommand> --help
2727
```
2828

29-
> Be sure to run `ionic <command> --help` in your project directory.
30-
>
31-
> For some commands, such as `ionic serve`, the help documentation is contextual to the type of your project, e.g. React vs Angular.
29+
:::note
30+
Be sure to run `ionic <command> --help` in your project directory.
31+
32+
For some commands, such as `ionic serve`, the help documentation is contextual to the type of your project, e.g. React vs Angular.
33+
:::
3234

3335
<!-- TODO: image? -->
3436

docs/cli/configuration.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,11 @@ module.exports = function(ctx) {
111111

112112
The Ionic CLI supports a multi-app configuration setup, which involves multiple Ionic apps and shared code within a single repository, or [monorepo](../reference/glossary.md#monorepo).
113113

114-
> These docs give an overview of the multi-app feature of the Ionic CLI, but don't really go into details for each framework.
115-
>
116-
> If you're using Angular, please see [this article](https://github.com/ionic-team/ionic-cli/wiki/Angular-Monorepo) for examples.
114+
:::note
115+
These docs give an overview of the multi-app feature of the Ionic CLI, but don't really go into details for each framework.
116+
117+
If you're using Angular, please see [this article](https://github.com/ionic-team/ionic-cli/wiki/Angular-Monorepo) for examples.
118+
:::
117119

118120
### Setup Steps
119121

@@ -192,7 +194,9 @@ $ ionic start "My New App" --no-deps
192194
193195
If an app was created in a way other than `ionic start`, for example by using a prebuilt template, use `ionic init` to register the existing app with the multi-app project.
194196
195-
> Make sure the app doesn't have an existing `ionic.config.json`.
197+
:::note
198+
Make sure the app doesn't have an existing `ionic.config.json`.
199+
:::
196200

197201
```shell
198202
$ cd apps/existing-app/

docs/cli/livereload.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ $ ionic capacitor run ios -l --external
2323
$ ionic capacitor run android -l --external
2424
```
2525

26-
> Remember, with the `--external` option, others on your Wi-Fi network will be able to access your app.
26+
:::note
27+
Remember, with the `--external` option, others on your Wi-Fi network will be able to access your app.
28+
:::
2729

2830
### Cordova
2931

@@ -41,7 +43,9 @@ $ ionic cordova run android -l
4143

4244
For iOS devices, port forwarding is not yet an option. This means you'll need to connect your device to the same Wi-Fi network as your computer and use an external address for the dev server.
4345

44-
> You can track [this issue](https://github.com/ionic-team/native-run/issues/20) for progress on iOS port forwarding with Ionic.
46+
:::note
47+
You can track [this issue](https://github.com/ionic-team/native-run/issues/20) for progress on iOS port forwarding with Ionic.
48+
:::
4549

4650
In some cases, the Ionic CLI won't know the address with which to configure the Web View, so you may be prompted to select one. Be sure to select the address of your computer on your Wi-Fi network.
4751

@@ -51,7 +55,9 @@ The following all-in-one command will start a live-reload server on **all addres
5155
$ ionic cordova run ios -l --external
5256
```
5357

54-
> Remember, with the `--external` option, others on your Wi-Fi network will be able to access your app.
58+
:::note
59+
Remember, with the `--external` option, others on your Wi-Fi network will be able to access your app.
60+
:::
5561

5662
## Tips
5763

docs/deployment/app-store.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,6 @@ An app can be updated by either submitting a new version to Apple, or by using a
6262

6363
With <strong>Live Updates</strong>, app changes can be pushed in realtime directly to users from the Appflow dashboard, without waiting for App Store approvals.
6464

65-
> In order for the iOS App Store to accept the updated build, the config.xml file will need to be edited to increment the version value, then rebuild the app for release following the same instructions above.
65+
:::note
66+
In order for the iOS App Store to accept the updated build, the config.xml file will need to be edited to increment the version value, then rebuild the app for release following the same instructions above.
67+
:::

docs/deployment/play-store.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ $ keytool -genkey -v -keystore my-release-key.keystore -alias alias_name -keyalg
2727

2828
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.
2929

30-
> WARNING: Save this file and keep it somewhere safe. If it is lost the Google Play Store will not accept updates for this app!
30+
:::caution
31+
Save this file and keep it somewhere safe. If it is lost the Google Play Store will not accept updates for this app!
32+
:::
3133

3234
To sign the unsigned APK, run the jarsigner tool which is also included in the Android SDK:
3335

@@ -51,7 +53,9 @@ Now that a release APK has been generated, a Play Store listing can be written a
5153

5254
To start, visit the [Google Play Store Developer Console](https://play.google.com/apps/publish) and create a new developer account.
5355

54-
> Making a developer account with Google Play costs $25 USD.
56+
:::note
57+
Making a developer account with Google Play costs $25 USD.
58+
:::
5559

5660
Once a developer account has been created, go ahead and click the `Create an Application`
5761

@@ -65,4 +69,6 @@ When ready, upload the signed release APK that was generated and publish the app
6569

6670
As an app evolves, it will need to be updated with new features and fixes. An app can be updated by either submitting a new version to the Google Play Store, or by using a live update service like Appflow's Live Update feature. Using Live Updates, changes can be pushed directly to users from the Appflow dashboard, without submitting changes to the Play Store. Learn more about Live Updates <a href="https://ionic.io/docs/appflow/deploy/intro" target="_blank">here</a>.
6771

68-
> In order for the Google Play Store to accept updated APKs, the config.xml file will need to be edited to increment the version value, then rebuild the app for release following the instructions above.
72+
:::note
73+
In order for the Google Play Store to accept updated APKs, the config.xml file will need to be edited to increment the version value, then rebuild the app for release following the instructions above.
74+
:::

docs/developer-resources/guides/first-app-v4/intro.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,11 @@ Run the following in the command line:
2121
$ npm install -g @ionic/cli cordova
2222
```
2323

24-
> The `-g` option means _install globally_. When packages are installed globally, `EACCES` permission errors can occur.
25-
>
26-
> Consider setting up npm to operate globally without elevated permissions. See [Resolving Permission Errors](../../../developing/tips.md#resolving-permission-errors) for more information.
24+
:::note
25+
The `-g` option means _install globally_. When packages are installed globally, `EACCES` permission errors can occur.
26+
27+
Consider setting up npm to operate globally without elevated permissions. See [Resolving Permission Errors](../../../developing/tips.md#resolving-permission-errors) for more information.
28+
:::
2729

2830
## Create an App
2931
Next, create an Ionic Angular app using our “Tabs” app template:

docs/developing/android.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ This guide covers how to run and debug Ionic apps on Android emulators and devic
1212

1313
Android Studio is also used to [create Android virtual devices](android.md#creating-an-android-virtual-device), which are required for the Android emulator. Ionic apps can also be [launched to a device](android.md#set-up-an-android-device).
1414

15-
> We don't recommend using Android Studio for _developing_ Ionic apps. Instead, it should only really be used to build and run your apps for the native Android platform and to manage the Android SDK and virtual devices.
15+
:::note
16+
We don't recommend using Android Studio for _developing_ Ionic apps. Instead, it should only really be used to build and run your apps for the native Android platform and to manage the Android SDK and virtual devices.
17+
:::
1618

1719
### Installing Android Studio
1820

@@ -97,7 +99,9 @@ Additional setup is required for Cordova to support programmatic builds. This se
9799

98100
Native Android apps are compiled with the <a href="https://java.com/en/" target="_blank">Java</a> programming language. Download JDK8 from the <a href="https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html" target="_blank">download page</a>.
99101

100-
> Unfortunately, Cordova is not compatible with the latest version of Java.
102+
:::note
103+
Unfortunately, Cordova is not compatible with the latest version of Java.
104+
:::
101105

102106
### Gradle
103107

@@ -173,15 +177,19 @@ Once an app is running on an Android device or emulator, it can be debugged with
173177
174178
Chrome has web developer tool support for Android simulators and devices. Go to `chrome://inspect` in Chrome while the simulator is running or a device is connected to the computer and **Inspect** the app that needs to be debugged.
175179
176-
> Make sure your application is running on the device or simulator, or it will not show up in the list.
180+
:::note
181+
Make sure your application is running on the device or simulator, or it will not show up in the list.
182+
:::
177183
178184
![Android Chrome DevTools](/img/running/android-chrome-devtools.png)
179185
180186
### Viewing Native Logs
181187
182188
If running with Android Studio, native logs can be found in **Logcat**.
183189
184-
> If the **Logcat** window is hidden, you can enable it in **View** &raquo; **Tool Windows** &raquo; **Logcat**.
190+
:::note
191+
If the **Logcat** window is hidden, you can enable it in **View** &raquo; **Tool Windows** &raquo; **Logcat**.
192+
:::
185193
186194
![Android Studio Logcat](/img/running/android-studio-logcat.png)
187195

docs/developing/hardware-back-button.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ import TabItem from '@theme/TabItem';
55

66
The hardware back button is found on most Android devices. In native applications it can be used to close modals, navigate to the previous view, exit an app, and more. By default in Ionic, when the back button is pressed, the current view will be popped off the navigation stack, and the previous view will be displayed. If no previous view exists in the navigation stack, nothing will happen. This guide will show how to customize the behavior of the hardware back button.
77

8-
> The hardware back button refers to the physical back button on an Android device and should not be confused with either the browser back button or `ion-back-button`. The information in this guide only applies to Android devices.
8+
:::note
9+
The hardware back button refers to the physical back button on an Android device and should not be confused with either the browser back button or `ion-back-button`. The information in this guide only applies to Android devices.
10+
:::
911

1012
## Hardware Back Button in Capacitor and Cordova
1113

@@ -21,7 +23,9 @@ When running your app in a mobile browser or as a PWA, hardware back button cust
2123

2224
For complete hardware back button support, we recommend using Capacitor or Cordova.
2325

24-
> The `ionBackButton` event will not be emitted when running an app in a browser or as a PWA.
26+
:::note
27+
The `ionBackButton` event will not be emitted when running an app in a browser or as a PWA.
28+
:::
2529

2630
## Basic Usage
2731

0 commit comments

Comments
 (0)