From e43e1d4c5b7c7dce5a39bec2c000b2b94bce29ff Mon Sep 17 00:00:00 2001 From: jp-knj Date: Sat, 17 May 2025 04:21:30 +0900 Subject: [PATCH 1/2] add doc --- .../guides/migrate-to-astro/from-pelican.mdx | 64 +++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 src/content/docs/ja/guides/migrate-to-astro/from-pelican.mdx diff --git a/src/content/docs/ja/guides/migrate-to-astro/from-pelican.mdx b/src/content/docs/ja/guides/migrate-to-astro/from-pelican.mdx new file mode 100644 index 0000000000000..5c01900005980 --- /dev/null +++ b/src/content/docs/ja/guides/migrate-to-astro/from-pelican.mdx @@ -0,0 +1,64 @@ +--- +title: Pelicanからの移行 +description: PelicanプロジェクトをAstroに移行するためのガイド +sidebar: +label: Pelican +type: migration +stub: false +framework: Pelican +i18nReady: true +--- + +import PackageManagerTabs from '~/components/tabs/PackageManagerTabs.astro'; + +[Pelican](https://getpelican.com)は、Pythonで構築されたオープンソースの静的サイトジェネレーターです。 + +## PelicanとAstroの類似点 + +PelicanとAstroには、以下のような共通点があり、移行をスムーズに行えます。 + +- どちらも[コンテンツ重視のウェブサイト](/ja/concepts/why-astro/#content-driven)（例：ブログ）に適した静的サイトジェネレーターです。 + +- 両者とも[Markdownでの執筆](/ja/guides/markdown-content/)をサポートしており、ページメタデータにYAMLフロントマターを使用できます。Astroでは特別なフロントマターのプロパティが少ないため、PelicanのMarkdownファイルとそのフロントマターをそのまま活用できます。 + +## PelicanとAstroの主な違い + +- PelicanはMarkdownに加えてreStructuredText（`.rst`）にも対応していますが、Astroでは[MarkdownおよびMDX](/ja/guides/markdown-content/)のみ対応しており、reStructuredTextは非対応です。 + +- PelicanはHTMLファイルとJinjaテンプレートを使ってレイアウトを構築しますが、AstroはJSX風構文を採用した[`.astro`ファイル](/ja/basics/astro-components/)でテンプレートやコンポーネントを構成します。すべての有効なHTMLは`.astro`構文としても有効です。 + +- Pelicanにはブログ機能が組み込まれていますが、Astroではそれらを自分で構築する必要があります。もしくは、[公式のブログテーマ](https://github.com/withastro/astro/tree/latest/examples/blog)を使えば、同等の機能をすぐに利用できます。 + +## PelicanサイトをAstroへ移行する + +Pelican製のドキュメントサイトをAstroへ移行するには、[公式Starlightドキュメントテーマ](https://starlight.astro.build)を利用するか、[テーマショーケース](https://astro.build/themes/)から他のドキュメントテーマを選びます。 + +`create astro`コマンドに`--template`引数を渡すことで、公式スターターを使って新しいAstroプロジェクトを作成できます。また、[GitHub上の既存リポジトリからプロジェクトを開始](/ja/install-and-setup/)することも可能です。 + + + + ```shell + npm create astro@latest -- --template starlight + ``` + + + ```shell + pnpm create astro@latest --template starlight + ``` + + + ```shell + yarn create astro --template starlight + ``` + + + +既存のMarkdownファイルを[Markdownページとして作成](/ja/guides/markdown-content/)し、Pelicanの`content/`ディレクトリからAstroの`src/pages/`へコピーすることで、[ファイルベースルーティング](/ja/guides/routing/)を活用できます。 + +Pelicanではレイアウトやメタデータ管理が自動化されていますが、Astroでは[Markdownレイアウトとしてラップする構成](/ja/basics/layouts/#markdown-layouts)を自分で組む必要があります。 + +Astroにも多くの[公式インテグレーション](/ja/guides/integrations-guide/)があり、MDX対応などを追加できます。また、[Astro Integration API](/ja/reference/integrations-reference/)を使えば、自分用のカスタムインテグレーションも作成できます。 + +ポートフォリオサイトやブログサイトへの移行を検討している場合は、[astro.new](https://astro.new)で他のスターターテンプレートを確認できます。GitHubリポジトリのリンクに加え、IDX・StackBlitz・CodeSandbox・Gitpodで即時起動できるリンクも用意されています。 + +## コミュニティリソース From 88a550e81cb8060051c0787bce91aee1710130e6 Mon Sep 17 00:00:00 2001 From: jp-knj Date: Tue, 27 May 2025 23:50:02 +0900 Subject: [PATCH 2/2] fix broken link --- .../docs/ja/guides/migrate-to-astro/from-pelican.mdx | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/content/docs/ja/guides/migrate-to-astro/from-pelican.mdx b/src/content/docs/ja/guides/migrate-to-astro/from-pelican.mdx index 5c01900005980..df630a6cddfbb 100644 --- a/src/content/docs/ja/guides/migrate-to-astro/from-pelican.mdx +++ b/src/content/docs/ja/guides/migrate-to-astro/from-pelican.mdx @@ -2,7 +2,7 @@ title: Pelicanからの移行 description: PelicanプロジェクトをAstroに移行するためのガイド sidebar: -label: Pelican + label: Pelican type: migration stub: false framework: Pelican @@ -17,7 +17,7 @@ import PackageManagerTabs from '~/components/tabs/PackageManagerTabs.astro'; PelicanとAstroには、以下のような共通点があり、移行をスムーズに行えます。 -- どちらも[コンテンツ重視のウェブサイト](/ja/concepts/why-astro/#content-driven)（例：ブログ）に適した静的サイトジェネレーターです。 +- どちらも[コンテンツ重視のウェブサイト](/ja/concepts/why-astro/#コンテンツ駆動)（例：ブログ）に適した静的サイトジェネレーターです。 - 両者とも[Markdownでの執筆](/ja/guides/markdown-content/)をサポートしており、ページメタデータにYAMLフロントマターを使用できます。Astroでは特別なフロントマターのプロパティが少ないため、PelicanのMarkdownファイルとそのフロントマターをそのまま活用できます。 @@ -55,10 +55,14 @@ Pelican製のドキュメントサイトをAstroへ移行するには、[公式S 既存のMarkdownファイルを[Markdownページとして作成](/ja/guides/markdown-content/)し、Pelicanの`content/`ディレクトリからAstroの`src/pages/`へコピーすることで、[ファイルベースルーティング](/ja/guides/routing/)を活用できます。 -Pelicanではレイアウトやメタデータ管理が自動化されていますが、Astroでは[Markdownレイアウトとしてラップする構成](/ja/basics/layouts/#markdown-layouts)を自分で組む必要があります。 +Pelicanではレイアウトやメタデータ管理が自動化されていますが、Astroでは[Markdownレイアウトとしてラップする構成](/ja/basics/layouts/#markdownのレイアウト)を自分で組む必要があります。 Astroにも多くの[公式インテグレーション](/ja/guides/integrations-guide/)があり、MDX対応などを追加できます。また、[Astro Integration API](/ja/reference/integrations-reference/)を使えば、自分用のカスタムインテグレーションも作成できます。 ポートフォリオサイトやブログサイトへの移行を検討している場合は、[astro.new](https://astro.new)で他のスターターテンプレートを確認できます。GitHubリポジトリのリンクに加え、IDX・StackBlitz・CodeSandbox・Gitpodで即時起動できるリンクも用意されています。 ## コミュニティリソース + +:::note[リソースを共有する] +PelicanサイトからAstroへの移行に役立つ動画やブログ記事などを見つけた（または作成した）場合は、ぜひ[こちらのリスト](https://github.com/withastro/docs/edit/main/src/content/docs/ja/guides/migrate-to-astro/from-pelican.mdx)に追加してください！ +:::