diff --git a/README.md b/README.md index 06facdd..d194c11 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,66 @@ -# Astro Example: MDX +# hello-programmer-world + +プログラマー向けの学習コンテンツサイトです。 + +## 実行手順 + +### 必要な環境 + +- Node.js (推奨: v18以上) +- pnpm + +### pnpmのインストール + +pnpmがインストールされていない場合は、以下のコマンドでインストールしてください。 ```sh -pnpm create astro@latest -- --template with-mdx +npm install -g pnpm ``` -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-mdx) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-mdx) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/with-mdx/devcontainer.json) +### セットアップ -This example showcases using [`@astrojs/mdx`](https://www.npmjs.com/package/@astrojs/mdx) to author content using [MDX](https://mdxjs.com/). +1. リポジトリをクローンします + +```sh +git clone +cd hello-programmer-world +``` + +2. 依存パッケージをインストールします + +```sh +pnpm install +``` + +### 開発サーバーの起動 + +```sh +pnpm dev +``` + +開発サーバーが起動し、ブラウザで `http://localhost:4321` にアクセスできます。 +ファイルを編集すると、自動的にブラウザがリロードされます。 + +### ビルド + +```sh +pnpm build +``` + +本番用のファイルが `dist/` ディレクトリに生成されます。 + +### プレビュー + +ビルドしたファイルをローカルでプレビューできます。 + +```sh +pnpm preview +``` + +## 技術スタック + +- [Astro](https://astro.build/) - 静的サイトジェネレーター +- [MDX](https://mdxjs.com/) - Markdownの拡張記法 +- [Tailwind CSS](https://tailwindcss.com/) - CSSフレームワーク +- [Preact](https://preactjs.com/) - UIコンポーネント +- [Biome](https://biomejs.dev/) - リンター・フォーマッター