Skip to content

Commit

Permalink
feat: READMEを更新
Browse files Browse the repository at this point in the history
  • Loading branch information
OJII3 committed Sep 2, 2024
1 parent 17c12bd commit f1b8b7b
Showing 1 changed file with 36 additions and 48 deletions.
84 changes: 36 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,56 @@
# Astro Starter Kit: Blog
# ホームページ with Astro

```sh
npm create astro@latest -- --template blog
```
## 技術スタック

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/blog)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/blog)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/blog/devcontainer.json)
- Astro
- TypeScript
- Tailwind CSS
- Kibela GraphQL API

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## 必要なもの

![blog](https://github.com/withastro/astro/assets/2244813/ff10799f-a816-4703-b967-c78997e8323d)
- Bun

Features:
## セットアップ

- ✅ Minimal styling (make it your own!)
- ✅ 100/100 Lighthouse performance
- ✅ SEO-friendly with canonical URLs and OpenGraph data
- ✅ Sitemap support
- ✅ RSS Feed support
- ✅ Markdown & MDX support
1. このリポジトリをクローン
2. `bun install` を実行

## 🚀 Project Structure
## 開発

Inside of your Astro project, you'll see the following folders and files:
### 開発サーバー

```text
├── public/
├── src/
│   ├── components/
│   ├── content/
│   ├── layouts/
│   └── pages/
├── astro.config.mjs
├── README.md
├── package.json
└── tsconfig.json
```sh
bun dev
```
実行すると `http://localhost:4321` に開発サーバーが立ち上がります. ファイルを編集すると自動的にブラウザに反映されます.

Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
### ビルド

There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

The `src/content/` directory contains "collections" of related Markdown and MDX documents. Use `getCollection()` to retrieve posts from `src/content/blog/`, and type-check your frontmatter using an optional schema. See [Astro's Content Collections docs](https://docs.astro.build/en/guides/content-collections/) to learn more.
```sh
bun run --bun build
```
実行後、`build/` ディレクトリにビルドされたファイルが出力されます. これを本番環境でデプロイします.

Any static assets, like images, can be placed in the `public/` directory.
### プレビュー

## 🧞 Commands
```sh
bun preview
```
ビルドしたファイルをローカルサーバーでプレビューします.

All commands are run from the root of the project, from a terminal:
### リンタ

| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
```sh
bun lint
```

## 👀 Want to learn more?
Biome を用いてコードをチェックします. Prettier によるフォーマットのチェックも行われます.

Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
### フォーマット

## Credit
```sh
bun fmt
```

This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/).
Prettier を用いてコードをフォーマットします. Biome によるコードの修正も行われます

0 comments on commit f1b8b7b

Please sign in to comment.