Ravin セットアップガイド v0.1
このドキュメントでは、Ravinテーマのインストールから初期設定までの手順を解説します。
Warning
現在提供しているのはベータ版です。本番環境での利用の際は、事前に十分なテストを行ってください。
1. インストール手順
お使いのパッケージマネージャーに合わせて、以下のコマンドを実行してください。
npm install ravin pnpm add ravin yarn add ravin 2. 初期セットアップ
-
プロジェクトの初期化
Astroプロジェクトを作成し、ディレクトリに移動します。
-
設定ファイルの編集
astro.config.mjsを開き、Ravinをインテグレーションに追加します。 -
開発サーバーの起動
npm run devでローカルサーバーを起動し、表示を確認します。
3. プロパティ一覧
ドキュメント内でAPIリファレンスなどを記述する際は、Tableコンポーネントを使用します。
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
title | string | 〇 | 記事またはドキュメントのタイトル |
date | Date | △ | 公開日(ブログ用途で推奨) |
tags | string[] | △ | 関連するタグの配列 |
次のステップ
基本設定が完了したら、次はコンポーネントの使い方を学びましょう。ドキュメントのフッターナビゲーションにはNavCardが適しています。
← トップへ戻る