導入ガイド

Ravin Setup Guide v0.2

このページは src/content/docs/getting-started.mdx から生成されています。ドキュメント用途に特化した構成のデモです。

注意事項

現在提供しているバージョンはベータ版です。ディレクトリ構造やAPIが予告なく変更される可能性があります。

1. パッケージのインストール

お使いのパッケージマネージャーに合わせて、以下のコマンドを実行してください。RavinはAstroプロジェクト上で動作します。

npm install ravin
 
pnpm add ravin
 
bun add ravin

2. 初期セットアップの手順

  1. Astroプロジェクトの初期化

    まずはベースとなるAstroのプロジェクトを作成します。

  2. インテグレーションの追加

    astro.config.mjs を開き、インストールしたRavinを追加します。

  3. 開発サーバーの起動

    npm run dev などでローカル環境を立ち上げ、Ravinのコンポーネントが反映されているか確認します。

3. 設定プロパティ一覧

ドキュメント内で設定値やAPIリファレンスを記述する際は、以下のように Table コンポーネントを使用すると綺麗に整理できます。

プロパティ名型必須説明
theme'light' | 'dark'△初期表示のテーマカラー
siteUrlstring〇OGPやSitemap生成のための基本URL
langstring△<html>タグに出力される言語設定

以上で基本的なセットアップは完了です。必要に応じて他のコンポーネントもご確認ください。