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

Lines changed: 3 additions & 1 deletion
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

Lines changed: 6 additions & 2 deletions
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

Lines changed: 3 additions & 1 deletion
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

Lines changed: 12 additions & 4 deletions
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

Lines changed: 3 additions & 1 deletion
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

Lines changed: 11 additions & 5 deletions
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

Lines changed: 3 additions & 1 deletion
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

Lines changed: 5 additions & 3 deletions
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

Lines changed: 8 additions & 4 deletions
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

Lines changed: 9 additions & 3 deletions
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

0 commit comments

Comments
 (0)