Skip to content

chore(docusaurus): upgrade to v3 - JP #3363

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 24 commits into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
3599e66
chore(docusaurus): upgrade to v3
thetaPC Jan 3, 2024
586a330
chore(docusaurus): changed scripts ext to mjs
thetaPC Jan 4, 2024
7da7b1b
chore(docusaurus): update tsconfig
thetaPC Jan 4, 2024
176308c
chore(docusaurus): update versioned sidebars json
thetaPC Jan 4, 2024
8a3930c
chore(docusaurus): switch to warning admonitions
thetaPC Jan 4, 2024
3c0d3ef
chore(docusaurus): corrent mdx structure
thetaPC Jan 4, 2024
0f9fe53
chore(docusaurus): add missing apostrophe
thetaPC Jan 4, 2024
dd259b8
chore(docusaurus): last of correct mdx syntax
thetaPC Jan 4, 2024
d2d2e48
chore(docusaurus): switch to DocRoot
thetaPC Jan 4, 2024
54e16e1
chore(docusaurus): correct attribute syntax
thetaPC Jan 4, 2024
82792fa
chore(docusaurus): rename more docRoot
thetaPC Jan 4, 2024
82cedb2
chore(docusaurus): update prettierignore
thetaPC Jan 4, 2024
2614c2c
chore(docusaurus): add missing component import
thetaPC Jan 4, 2024
059cc61
chore(docusaurus): update comment on doc. config
thetaPC Jan 4, 2024
2d978e1
chore(docusaurus): more fixes
thetaPC Jan 4, 2024
0be7766
chore(docusaurus): actually change the file path for DocRoot
thetaPC Jan 4, 2024
4611a65
chore(docusaurus): update caution admonition sytles to warning
thetaPC Jan 4, 2024
6d5c659
chore(docusaurus): update styles
thetaPC Jan 4, 2024
f0a54f1
chore(docusaurus): add prettier-ignore
thetaPC Jan 4, 2024
8e67190
chore(docusaurus): escape curly brackets
thetaPC Jan 5, 2024
70bc9cd
chore(docusaurus): revert cspell wordlist
thetaPC Jan 5, 2024
cc1813b
chore(docusaurus): revert capitalization
thetaPC Jan 5, 2024
0e65f43
chore(docusaurus): revert more attribute syntax
thetaPC Jan 5, 2024
c2fc4f8
chore(docusaurus): add margin between icon and link
thetaPC Jan 12, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
src/theme/DocItem
src/theme/DocPage
src/theme/DocRoot
legacy-stencil-components
scripts/bak

docs/api
docs/native
versioned_docs/version-v*/native
docs/cli/commands

static/code/stackblitz
Expand Down
4 changes: 2 additions & 2 deletions docs/angular/build-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ See the [Standalone Migration Guide](#migrating-from-modules-to-standalone) for

### Usage with Standalone-based Applications

:::caution
:::warning
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.
:::

Expand Down Expand Up @@ -177,7 +177,7 @@ export class HomePage {}

### Usage with NgModule-based Applications

:::caution
:::warning
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.
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ import { LoginComponent } from './login.component';

## Standalone Components

:::caution Experimental API
:::warning Experimental API

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.

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem';
/>
</head>

:::caution Looking for `ion-slides`?
:::warning Looking for `ion-slides`?
`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.
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/virtual-scroll.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 仮想スクロール

:::caution Looking for `ion-virtual-scroll`?
:::warning Looking for `ion-virtual-scroll`?

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

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/your-first-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Here’s the finished app running on all 3 platforms:
width="560"
height="315"
src="https://www.youtube.com/embed/0ASQ13Y1Rk4"
frameborder="0"
frameBorder="0"
allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>
Expand Down
7 changes: 2 additions & 5 deletions docs/core-concepts/fundamentals.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,8 @@ Web テクノロジで構築されたアプリ(Ionic アプリなど)の素

Ionic の最も一般的な使用例の 1 つは、 <a href="https://www.apple.com/ios/app-store/" target="_blank">App Store</a> と <a href="https://play.google.com/" target="_blank">Play Store</a> の両方からダウンロードできるアプリを作成することです。iOS と Android の両方のソフトウェア開発キット(SDK)は、完全なネイティブ SDK アクセスを可能にしながら、あらゆる Ionic アプリをレンダリングする [Web Views](webview.md) を提供します。

<a href="https://capacitorjs.com/" target="_blank">
Capacitor
</a> や <a href="https://cordova.apache.org/" target="_blank">
Cordova
</a> などのプロジェクトは、IonicアプリにネイティブSDKへのアクセスを与えるためによく使われています。つまり、開発者は一般的なWeb開発ツールを使ってアプリを素早く構築することができ、かつデバイスの加速度センサー、カメラ、GPSなどのネイティブ機能にアクセスすることができるのです。
<!-- prettier-ignore -->
<a href="https://capacitorjs.com/" target="_blank">Capacitor</a> や <a href="https://cordova.apache.org/" target="_blank">Cordova</a> などのプロジェクトは、IonicアプリにネイティブSDKへのアクセスを与えるためによく使われています。つまり、開発者は一般的なWeb開発ツールを使ってアプリを素早く構築することができ、かつデバイスの加速度センサー、カメラ、GPSなどのネイティブ機能にアクセスすることができるのです。

## テーマ

Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/play-store.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ $ keytool -genkey -v -keystore my-release-key.keystore -alias alias_name -keyalg

このコマンドを実行し、プロンプトに答えると、カレントディレクトリに `my-release-key.keystore` という名前のファイルが作成されます。

:::caution
:::warning
このファイルを保存し、安全な場所に保管してください。このファイルを紛失すると、Google Play ストアはこのアプリのアップデートを受け付けません!
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/play-store.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ keytool -genkey -v -keystore my-release-key.keystore -alias alias_name -keyalg R

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.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,15 +101,15 @@ Now comes the fun part: testing out the native app on your device! For iOS, the
src="https://fast.wistia.net/embed/iframe/s5v4fujv7w?videoFoam=true"
title="Wistia video player"
allowtransparency="true"
frameborder="0"
frameBorder="0"
scrolling="no"
class="wistia_embed"
name="wistia_embed"
allowfullscreen
mozallowfullscreen
webkitallowfullscreen
oallowfullscreen
msallowfullscreen
mozallowFullScreen
webkitallowFullScreen
oallowFullScreen
msallowFullScreen
width="100%"
height="100%"
></iframe>
Expand All @@ -130,15 +130,15 @@ In the upper right hand corner, click the Play button. Select your connected dev
src="https://fast.wistia.net/embed/iframe/b2ys5v4sno?videoFoam=true"
title="Wistia video player"
allowtransparency="true"
frameborder="0"
frameBorder="0"
scrolling="no"
class="wistia_embed"
name="wistia_embed"
allowfullscreen
mozallowfullscreen
webkitallowfullscreen
oallowfullscreen
msallowfullscreen
mozallowFullScreen
webkitallowFullScreen
oallowFullScreen
msallowFullScreen
width="100%"
height="100%"
></iframe>
Expand Down
17 changes: 5 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,18 +139,11 @@ Ionic Framework はコアチームによって積極的に開発され、メン

Ionic の開発者は世界 200 か国以上に何百万人もいます。コミュニティへの参加方法をいくつか紹介します:

- <a href="https://forum.ionicframework.com/" target="_blank">
Forum:
</a> A great place for asking questions and sharing ideas.
- <a href="https://twitter.com/ionicframework" target="_blank">
Twitter:
</a> Where we post updates and share content from the Ionic community.
- <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!
- <a href="https://ionicframework.com/contributors" target="_blank">
Content authoring:
</a> Write a technical blog or share your story with the Ionic community.
<!-- prettier-ignore -->
- <a href="https://forum.ionicframework.com/" target="_blank">Forum:</a> A great place for asking questions and sharing ideas.
- <a href="https://twitter.com/ionicframework" target="_blank">Twitter:</a> Where we post updates and share content from the Ionic community.
- <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!
- <a href="https://ionicframework.com/contributors" target="_blank">Content authoring:</a> Write a technical blog or share your story with the Ionic community.

## ライセンス

Expand Down
2 changes: 1 addition & 1 deletion docs/layout/css-utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ display CSS プロパティは、要素を表示するかどうかを決定し

### Responsive な Display 属性

画面サイズに基づいて表示を変更するクラスもあります。ただ `.ion-hide` ではなく `.ion-hide-{breakpoint}-{dir}` という特定の画面サイズでのみクラスを使用します。{breakpoint}は、[Ionic Breakpoints](#ionic-breakpoints)にリストされているブレークポイント名の 1 つです。 `{dir}` は、指定されたブレークポイントの上 (`up`) または下 (`down`) のすべての画面サイズで要素を非表示にするかどうかです。
画面サイズに基づいて表示を変更するクラスもあります。ただ `.ion-hide` ではなく `.ion-hide-{breakpoint}-{dir}` という特定の画面サイズでのみクラスを使用します。\{breakpoint\}は、[Ionic Breakpoints](#ionic-breakpoints)にリストされているブレークポイント名の 1 つです。 `{dir}` は、指定されたブレークポイントの上 (`up`) または下 (`down`) のすべての画面サイズで要素を非表示にするかどうかです。
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Backslashes are needed otherwise Docusaurus will think that {breakpoint} is a variable.


| Class | Description |
| -------------------- | ---------------------------------------------------------------------------------------------------- |
Expand Down
32 changes: 16 additions & 16 deletions docs/react.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ import DocsCards from '@components/global/DocsCards';

<PageStyles>

<div class='flex main-flex'>
<div class="pull-left">
<div className='flex main-flex'>
<div className="pull-left">
<h1>コードひとつで <br/> あらゆるプラットフォーム <br/> <strong>まさにReact</strong></h1>

- ✓ 100 以上のモバイルに最適化された React UI コンポーネント
Expand All @@ -32,7 +32,7 @@ import DocsCards from '@components/global/DocsCards';

</div>

<div class="pull-right">
<div className="pull-right">
<img src={require('@site/static/img/frameworks/react-logo.png').default} />
</div>
</div>
Expand All @@ -43,9 +43,9 @@ Ionic React は、Ionic Framework のネイティブ React バージョンで、

React を使用して、あらゆるプラットフォーム向けに受賞歴のあるアプリを出荷するために必要なすべてが揃っています。

<div class="flex" >
<div className="flex" >

<div class="pull-left">
<div className="pull-left">

## すばらしいデザイン

Expand All @@ -55,15 +55,15 @@ React を使用して、あらゆるプラットフォーム向けに受賞歴

</div>

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

</div>

<div class="flex reverse" >
<div className="flex reverse" >

<div class="pull-left">
<div className="pull-left">

## 使い慣れたツール

Expand All @@ -72,39 +72,39 @@ React バージョン 16.8 以降に対応しています。

</div>

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

</div>

<div class="flex">
<div className="flex">

<div class="pull-left">
<div className="pull-left">

## More than mobile

最新のネイティブランタイムである [Capacitor](https://capacitorjs.com) を使用して、Ionic React プロジェクトをネイティブの iOS、Android、Electron、Web に Progressive Web App としてデプロイできます。すべて 1 つの共有コードベースで。

</div>

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

</div>

<div class="flex reverse">
<div className="flex reverse">

<div class="pull-left">
<div className="pull-left">

## まさに React

結局のところ、ただの React なのです。Ionic React はオープンな Web 標準とビルトインのブラウザ機能を使用しているため、何百万とある Web ライブラリのどれとも互換性があります。

</div>

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

Expand Down
2 changes: 1 addition & 1 deletion docs/react/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ title: Migrating From IonSlides to Swiper.js
/>
</head>

:::caution Looking for `IonSlides`?
:::warning Looking for `IonSlides`?

`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.

Expand Down
2 changes: 1 addition & 1 deletion docs/react/virtual-scroll.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 仮想スクロール

:::caution Looking for `ion-virtual-scroll`?
:::warning Looking for `ion-virtual-scroll`?

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

Expand Down
2 changes: 1 addition & 1 deletion docs/react/your-first-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Here’s the finished app running on all 3 platforms:
width="560"
height="315"
src="https://www.youtube.com/embed/0ASQ13Y1Rk4"
frameborder="0"
frameBorder="0"
allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>
Expand Down
5 changes: 2 additions & 3 deletions docs/theming/css-shadow-parts.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,8 @@ Shadow Parts は、開発者がシャドウツリーの外側から、シャド

### How ::part works

<a href="https://developer.mozilla.org/en-US/docs/Web/CSS/::part" target="_blank" rel="noopener noreferrer">
`::part()`
</a> 擬似要素により、開発者はPart属性で公開されているシャドウツリー内の要素を選択することができます。
<!-- prettier-ignore -->
<a href="https://developer.mozilla.org/en-US/docs/Web/CSS/::part" target="_blank" rel="noopener noreferrer">`::part()`</a> 擬似要素により、開発者はPart属性で公開されているシャドウツリー内の要素を選択することができます。

`ion-select` は、値が選択されていないときにテキストをスタイル付けするための `placeholder` Part を公開していることが分かっているので、次のようにカスタマイズすることができます。

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ title: Debugging
width="560"
height="315"
src="https://www.youtube.com/embed/akh6V6Yw1lw"
frameborder="0"
frameBorder="0"
allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>
Expand Down
17 changes: 6 additions & 11 deletions docs/troubleshooting/native.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,8 @@ iOS デバイスでアプリケーションを実行するには、プロビジ

Cordova の場合、`config.xml` ファイルを開き、ルート要素 `<widget>` の `id` 属性を修正します。よりくわしい情報は [Cordova ドキュメント](https://cordova.apache.org/docs/en/latest/config_ref/#widget) をご参照ください。

2. <strong>
プロジェクトを <b>Xcode</b> で開く。
</strong>
<!-- prettier-ignore -->
2. <strong>プロジェクトを <b>Xcode</b> で開く。</strong>

Capacitor の場合、以下を実行し Xcode でアプリケーションを開いてください:

Expand All @@ -36,17 +35,13 @@ iOS デバイスでアプリケーションを実行するには、プロビジ

Cordova の場合、Xcode 開きます。**File** &raquo; **Open** からアプリケーションを見つけます。アプリケーション内の `platforms/ios` ディレクトリを開きます。

3. <strong>
<b>プロジェクト ナビゲーター</b>で、プロジェクトのルートを選択しエディタでプロジェクトを開きます。 **Identity**
セクションで、設定された Package ID がバンドル識別子と一致することを確認します。
</strong>
<!-- prettier-ignore -->
3. <strong><b>プロジェクト ナビゲーター</b>で、プロジェクトのルートを選択しエディタでプロジェクトを開きます。 **Identity** セクションで、設定された Package ID がバンドル識別子と一致することを確認します。</strong>

![Xcode Identity Setup](/img/running/ios-xcode-identity-setup.png)

4. <strong>
同じプロジェクトエディタの <b>署名</b> セクションで、<b>Automatically manage signing</b> が
有効になっていることを確認します。
</strong> 次に、Team から開発チームを選択します。開発チームがあれば、Xcode は プロビジョニングと署名を自動的に準備しようとします。
<!-- prettier-ignore -->
4. <strong>同じプロジェクトエディタの <b>署名</b> セクションで、<b>Automatically manage signing</b> が 有効になっていることを確認します。</strong> 次に、Team から開発チームを選択します。開発チームがあれば、Xcode は プロビジョニングと署名を自動的に準備しようとします。

![Xcode Signing Setup](/img/running/ios-xcode-signing-setup.png)

Expand Down
3 changes: 3 additions & 0 deletions docs/updating/4-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
title: Updating to v4
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Updating to Ionic 4

## Updating from Ionic 3 to 4
Expand Down
2 changes: 1 addition & 1 deletion docs/vue/slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ title: Migrating From ion-slides to Swiper.js
/>
</head>

:::caution Looking for `ion-slides`?
:::warning Looking for `ion-slides`?
`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.
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/vue/virtual-scroll.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 仮想スクロール

:::caution Looking for `ion-virtual-scroll`?
:::warning Looking for `ion-virtual-scroll`?

`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.

Expand Down
2 changes: 1 addition & 1 deletion docs/vue/your-first-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Here’s the finished app running on all 3 platforms:
width="560"
height="315"
src="https://www.youtube.com/embed/0ASQ13Y1Rk4"
frameborder="0"
frameBorder="0"
allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>
Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ module.exports = {
},
prism: {
theme: { plain: {}, styles: [] },
// https://github.com/FormidableLabs/prism-react-renderer/blob/5a1c93592c6475fb230bfcb8a9666b72b331638b/packages/generate-prism-languages/index.ts#L9-L24
// https://github.com/FormidableLabs/prism-react-renderer/blob/e6d323332b0363a633407fabab47b608088e3a4d/packages/generate-prism-languages/index.ts#L9-L25
additionalLanguages: ['shell-session', 'http'],
},
algolia: {
Expand Down
Loading