Skip to content

Commit

Permalink
chore(mdx): use proper comments and correct paths
Browse files Browse the repository at this point in the history
  • Loading branch information
thetaPC committed Apr 18, 2024
1 parent 22962a0 commit 1b55dd6
Show file tree
Hide file tree
Showing 77 changed files with 135 additions and 135 deletions.
2 changes: 1 addition & 1 deletion docs/api/action-sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ import CssCustomProperties from '@site/static/usage/v8/action-sheet/theming/css-

### Screen Readers

Action Sheets set aria properties in order to be [accessible](../reference/glossary#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the action sheet is being used in an app.
Action Sheets set aria properties in order to be [accessible](../reference/glossary.mdx#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the action sheet is being used in an app.

#### Role

Expand Down
2 changes: 1 addition & 1 deletion docs/api/alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ import Customization from '@site/static/usage/v8/alert/customization/index.md';

### Screen Readers

Alerts set aria properties in order to be [accessible](../reference/glossary#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the alert is being used in an app.
Alerts set aria properties in order to be [accessible](../reference/glossary.mdx#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the alert is being used in an app.

#### Role

Expand Down
2 changes: 1 addition & 1 deletion docs/api/col.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ See the [grid](./grid) documentation for more information.

## Column Alignment

By default, columns will stretch to fill the entire height of the row. Columns are [flex items](https://developer.mozilla.org/en-US/docs/Glossary/Flex_Item), so there are several [CSS classes](/docs/layout/css-utilities#flex-item-properties) that can be applied to a column to customize this behavior.
By default, columns will stretch to fill the entire height of the row. Columns are [flex items](https://developer.mozilla.org/en-US/docs/Glossary/Flex_Item), so there are several [CSS classes](/docs/layout/css-utilities.mdx#flex-item-properties) that can be applied to a column to customize this behavior.



Expand Down
4 changes: 2 additions & 2 deletions docs/api/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The content component provides an easy to use content area with some useful meth
to control the scrollable area. There should only be one content in a single
view.

Content, along with many other Ionic components, can be customized to modify its padding, margin, and more using the global styles provided in the [CSS Utilities](/docs/layout/css-utilities) or by individually styling it using CSS and the available [CSS Custom Properties](#css-custom-properties).
Content, along with many other Ionic components, can be customized to modify its padding, margin, and more using the global styles provided in the [CSS Utilities](/docs/layout/css-utilities.mdx) or by individually styling it using CSS and the available [CSS Custom Properties](#css-custom-properties).


## Basic Usage
Expand Down Expand Up @@ -97,7 +97,7 @@ import CSSProps from '@site/static/usage/v8/content/theming/css-properties/index

### Safe Area Padding

The content component will not automatically apply padding to any of its sides to account for the [safe area](/docs/theming/advanced#safe-area-padding). This is because the content component is often used in conjunction with other components that apply their own padding, such as [headers](./header) and [footers](./footer). However, if the content component is being used on its own, it may be desired to apply padding to the safe area. This can be done through CSS by using the `--ion-safe-area-(dir)` variables described in [Application Variables](../theming/advanced.md#application-variables).
The content component will not automatically apply padding to any of its sides to account for the [safe area](/docs/theming/advanced.mdx#safe-area-padding). This is because the content component is often used in conjunction with other components that apply their own padding, such as [headers](./header) and [footers](./footer). However, if the content component is being used on its own, it may be desired to apply padding to the safe area. This can be done through CSS by using the `--ion-safe-area-(dir)` variables described in [Application Variables](../theming/advanced.mdx#application-variables).

The most common use case for this is to apply padding to the top of the content to account for the status bar. This can be done by setting the `padding-top` property to the value of the `--ion-safe-area-top` variable.

Expand Down
4 changes: 2 additions & 2 deletions docs/api/datetime.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ Developers can provide their own buttons for advanced custom behavior.

Using the `highlightedDates` property, developers can style particular dates with custom text or background colors. This property can be defined as either an array of dates and their colors, or a callback that receives an ISO string and returns the colors to use.

When specifying colors, any valid CSS color format can be used. This includes hex codes, `rgba`, [color variables](../theming/colors), etc.
When specifying colors, any valid CSS color format can be used. This includes hex codes, `rgba`, [color variables](../theming/colors.mdx), etc.

To maintain a consistent user experience, the style of selected date(s) will always override custom highlights.

Expand All @@ -332,7 +332,7 @@ A callback is better when the highlighted dates are recurring, such as birthdays

### Global Theming

Ionic's powerful theming system can be used to easily change your entire app to match a certain theme. In this example, we used the [Color Creator](../theming/colors#new-color-creator) and the [Stepped Color Generator](../theming/themes#stepped-color-generator) to create a rose color palette that we can use for `ion-datetime`.
Ionic's powerful theming system can be used to easily change your entire app to match a certain theme. In this example, we used the [Color Creator](../theming/colors#new-color-creator) and the [Stepped Color Generator](../theming/themes.mdx#stepped-color-generator) to create a rose color palette that we can use for `ion-datetime`.

The benefit of this approach is that every component, not just `ion-datetime`, can automatically take advantage of this theme.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/fab.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import Positioning from '@site/static/usage/v8/fab/positioning/index.md';

### Safe Area

If there is no `ion-header` or `ion-footer` component, the fab may be covered by a device's notch, status bar, or other device UI. In these cases, the [safe area](/docs/theming/advanced#safe-area-padding) on the top and bottom is not taken into account. This can be adjusted by using the [`--ion-safe-area-(dir)` variables](/docs/theming/advanced#application-variables).
If there is no `ion-header` or `ion-footer` component, the fab may be covered by a device's notch, status bar, or other device UI. In these cases, the [safe area](/docs/theming/advanced.mdx#safe-area-padding) on the top and bottom is not taken into account. This can be adjusted by using the [`--ion-safe-area-(dir)` variables](/docs/theming/advanced.mdx#application-variables).

When using a fab with `vertical` set to `"top"` without an `ion-header`, the top margin needs to be set:

Expand Down
4 changes: 2 additions & 2 deletions docs/api/item.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Items are elements that can contain text, icons, avatars, images, inputs, and an

## Basic Usage

Items left align text and wrap when the text is wider than the item. We can modify this behavior using the CSS Utilities provided by Ionic Framework, such as using `.ion-text-nowrap` in the below example. See the [CSS Utilities Documentation](/docs/layout/css-utilities) for more classes that can be added to an item to transform the text.
Items left align text and wrap when the text is wider than the item. We can modify this behavior using the CSS Utilities provided by Ionic Framework, such as using `.ion-text-nowrap` in the below example. See the [CSS Utilities Documentation](/docs/layout/css-utilities.mdx) for more classes that can be added to an item to transform the text.

import Basic from '@site/static/usage/v8/item/basic/index.md';

Expand Down Expand Up @@ -189,7 +189,7 @@ This feature is not enabled by default on clickable items for the `md` mode, but
--item-detail-push-show: true;
```
See the [theming documentation](/docs/theming/css-variables) for more information.
See the [theming documentation](/docs/theming/css-variables.mdx) for more information.
-->

Expand Down
2 changes: 1 addition & 1 deletion docs/api/nav.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Nav is a standalone component for loading arbitrary components and pushing new c
Unlike Router Outlet, Nav is not tied to a particular router. This means that if we load a Nav component, and push other components to the stack, they will not affect the app's overall router. For example, you should not push a new component to `ion-nav` and expect the URL to update. This fits use cases where you could have a modal, which needs its own sub-navigation, without making it tied to the apps URL.

:::note
`ion-nav` is not meant to be used for routing. Instead, see the routing guides for [Angular](../angular/navigation), [React](../react/navigation), and [Vue](../vue/navigation), or [`ion-router`](./router) for vanilla JavaScript projects.
`ion-nav` is not meant to be used for routing. Instead, see the routing guides for [Angular](../angular/navigation.mdx), [React](../react/navigation.mdx), and [Vue](../vue/navigation.mdx), or [`ion-router`](./router) for vanilla JavaScript projects.
:::

## Using NavLink
Expand Down
2 changes: 1 addition & 1 deletion docs/api/router.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill';
The router is a component for handling routing inside vanilla and Stencil JavaScript projects.

:::note
Note: This component should only be used with vanilla and Stencil JavaScript projects. See the routing guides for [Angular](../angular/navigation), [React](../react/navigation), and [Vue](../vue/navigation) for framework-specific routing solutions.
Note: This component should only be used with vanilla and Stencil JavaScript projects. See the routing guides for [Angular](../angular/navigation.mdx), [React](../react/navigation.mdx), and [Vue](../vue/navigation.mdx) for framework-specific routing solutions.
:::


Expand Down
2 changes: 1 addition & 1 deletion docs/api/row.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ See the [grid](./grid) documentation for more information.

## Row Alignment

By default, columns will stretch to fill the entire height of the row and wrap when necessary. Rows are [flex containers](https://developer.mozilla.org/en-US/docs/Glossary/Flex_Container), so there are several [CSS classes](/docs/layout/css-utilities#flex-container-properties) that can be applied to a row to customize this behavior.
By default, columns will stretch to fill the entire height of the row and wrap when necessary. Rows are [flex containers](https://developer.mozilla.org/en-US/docs/Glossary/Flex_Container), so there are several [CSS classes](/docs/layout/css-utilities.mdx#flex-container-properties) that can be applied to a row to customize this behavior.



Expand Down
2 changes: 1 addition & 1 deletion docs/api/tabs.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ import Router from '@site/static/usage/v8/tabs/router/index.md';

:::tip Best Practices

Ionic has guides on best practices for routing patterns with tabs. Check out the guides for [Angular](/angular/navigation#working-with-tabs), [React](/react/navigation#working-with-tabs), and [Vue](/vue/navigation#working-with-tabs) for additional information.
Ionic has guides on best practices for routing patterns with tabs. Check out the guides for [Angular](../angular/navigation.mdx#working-with-tabs), [React](../react/navigation.mdx#working-with-tabs), and [Vue](../vue/navigation.mdx#working-with-tabs) for additional information.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/api/toast.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Toasts are intended to be subtle notifications and are not intended to interrupt

### Screen Readers

Toasts set aria properties in order to be [accessible](../reference/glossary#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the toast is being used in an app.
Toasts set aria properties in order to be [accessible](../reference/glossary.mdx#a11y) to screen readers, but these properties can be overridden if they aren't descriptive enough or don't align with how the toast is being used in an app.

#### Role

Expand Down
6 changes: 3 additions & 3 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ sidebar_label: Overview
/>
</head>

The Ionic command-line interface ([CLI](/docs/reference/glossary#cli)) is the go-to tool for developing Ionic apps.
The Ionic command-line interface ([CLI](/docs/reference/glossary.mdx#cli)) is the go-to tool for developing Ionic apps.

## Installation

Expand Down Expand Up @@ -41,14 +41,14 @@ For some commands, such as `ionic serve`, the help documentation is contextual t

## Architecture

The Ionic CLI is built with [TypeScript](/docs/reference/glossary#typescript) and [Node.js](/docs/reference/glossary#node). It supports Node 10.3+, but the latest Node LTS is always recommended. Follow development on the open source <a href="https://github.com/ionic-team/ionic-cli" target="_blank">GitHub repository</a>.
The Ionic CLI is built with [TypeScript](/docs/reference/glossary.mdx#typescript) and [Node.js](/docs/reference/glossary.mdx#node). It supports Node 10.3+, but the latest Node LTS is always recommended. Follow development on the open source <a href="https://github.com/ionic-team/ionic-cli" target="_blank">GitHub repository</a>.

## Troubleshooting

To troubleshoot issues with the Ionic CLI, the following may be useful:

- Make sure the latest version of the Ionic CLI is installed. Get the installed version by running `ionic --version`.
- Make sure the latest Node LTS is installed. See [Node & npm](/docs/intro/environment#node-npm) environment setup.
- Make sure the latest Node LTS is installed. See [Node & npm](/docs/intro/environment.mdx#node-npm) environment setup.
- The `--verbose` flag prints debugging messages, which may narrow down the issue.
- Connection issues may be due to improperly configured proxy settings. See [Using a Proxy](/docs/cli/using-a-proxy) to configure request proxying.
- The global Ionic CLI configuration directory is `~/.ionic` on all platforms. It can safely be deleted and the Ionic CLI will repopulate it, but all configuration (including user sessions) will be lost. Configure this directory with [CLI environment variables](/docs/cli/configuration#environment-variables).
2 changes: 1 addition & 1 deletion docs/cli/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ module.exports = function (ctx) {
<em>Available in CLI 6.2.0+</em>
</small>

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).
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.mdx#monorepo).

:::note
These docs give an overview of the multi-app feature of the Ionic CLI, but don't really go into details for each framework.
Expand Down
8 changes: 4 additions & 4 deletions docs/core-concepts/webview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ title: Web View

Web Views power web apps on native devices.

The Web View is automatically provided for apps integrated with [Capacitor](../reference/glossary.md#capacitor).
The Web View is automatically provided for apps integrated with [Capacitor](../reference/glossary.mdx#capacitor).

For [Cordova](../reference/glossary.md#cordova), Ionic maintains a <a href="https://github.com/ionic-team/cordova-plugin-ionic-webview" target="_blank">Web View plugin</a>. The plugin is provided by default when using the Ionic CLI.
For [Cordova](../reference/glossary.mdx#cordova), Ionic maintains a <a href="https://github.com/ionic-team/cordova-plugin-ionic-webview" target="_blank">Web View plugin</a>. The plugin is provided by default when using the Ionic CLI.

## What is a Web View?

Ionic apps are built using [web technologies](../reference/glossary.md#web-standards) and are rendered using Web Views, which are a full screen and full-powered web browser.
Ionic apps are built using [web technologies](../reference/glossary.mdx#web-standards) and are rendered using Web Views, which are a full screen and full-powered web browser.

Modern Web Views offer many built-in <a href="https://whatwebcando.today" target="_blank">HTML5 APIs</a> for hardware functionality such as cameras, sensors, GPS, speakers, and Bluetooth, but sometimes it may also be necessary to access platform-specific hardware APIs. In Ionic apps, hardware APIs can be accessed through a bridge layer, typically by using native plugins which expose JavaScript APIs.

Expand All @@ -28,7 +28,7 @@ The Ionic Web View plugin is specialized for modern JavaScript apps. For both iO

### CORS

Web Views enforce [CORS](../reference/glossary.md#cors), so it's important that external services properly handle cross-origin requests. See the [CORS FAQs](../troubleshooting/cors.md) for information on dealing with CORS in Ionic apps.
Web Views enforce [CORS](../reference/glossary.mdx#cors), so it's important that external services properly handle cross-origin requests. See the [CORS FAQs](../troubleshooting/cors.mdx) for information on dealing with CORS in Ionic apps.

### File Protocol

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-resources/guides/first-app-v4/theming.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ By changing these variables here and there, you can easily update the entire the
}
```

The easiest and most powerful way to create custom color palettes for your app’s UI is Ionic's [Color Generator tool](../../../theming/color-generator.md). As you change a color’s hex values, the embedded demo app automatically reflects the new colors. When you've finished making changes, simply copy and paste the generated code directly into your Ionic project.
The easiest and most powerful way to create custom color palettes for your app’s UI is Ionic's [Color Generator tool](../../../theming/color-generator.mdx). As you change a color’s hex values, the embedded demo app automatically reflects the new colors. When you've finished making changes, simply copy and paste the generated code directly into your Ionic project.

But wait, there’s more! Ionic automatically provides platform specific styles based on the device the application is running on, giving that native look and feel your users are used to:

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-resources/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Quickly get started with a new Ionic app entirely in the browser!

Check out the features that make working with TypeScript amazing.

### [Glossary](../reference/glossary.md)
### [Glossary](../reference/glossary.mdx)

A list of common terms you'll see while developing in Ionic.

Expand Down
Loading

0 comments on commit 1b55dd6

Please sign in to comment.