シングルカード
これはアイコン付きのスタンドアロンカードです。カードは重要な情報や機能を強調表示するのに役立ちます。
各アサイドタイプは、デフォルトのタイトルとともに ::: フェンス構文を使用します。
Starlight の組み込みアサイドコンポーネントは、角丸と重ね合わせたシャドウが適用されます:
.starlight-aside { border-radius: 0.75rem; box-shadow: 0 2px 4px rgba(0,0,0,0.04), 0 8px 16px rgba(0,0,0,0.08), 0 24px 48px rgba(0,0,0,0.12);}これは概要タブのコンテンツです。基本的なタブのレンダリングを確認するためのプレーンテキストを含んでいます。
これは詳細タブです。タブを切り替えてもページのリロードは発生しません。
最初のタブのプレーンな段落コンテンツです。
const greeting = "Hello from a code block inside a tab!";console.log(greeting);インラインコードを含む項目3これらの2つのタブグループは syncKey="pkg" を共有しています。一方のグループでタブを選択すると、もう一方も更新されます。
インストールコマンド:
npm install @f5-sales-demo/docs-themepnpm add @f5-sales-demo/docs-themeyarn add @f5-sales-demo/docs-theme実行コマンド:
npm run devpnpm devyarn devリポジトリをクローンする
git clone https://github.com/example/repo.gitcd repo依存関係をインストールする
npm install開発サーバーを起動する
npm run devサイトは http://localhost:4321 で利用可能になります。
シングルカード
これはアイコン付きのスタンドアロンカードです。カードは重要な情報や機能を強調表示するのに役立ちます。
パフォーマンス
Astro はデフォルトでゼロJS を提供し、高速なページ読み込みを実現します。
カスタマイズ可能
Starlight は広範なテーマ設定とプラグインオプションを提供します。
アクセシブル
組み込みのアクセシビリティ機能により、すべてのユーザーがコンテンツにアクセスできます。
ドキュメント化済み
充実したドキュメントにより、スムーズに始められます。
ステップ1
プロジェクトの設定と環境変数を構成します。
ステップ2
MDX 形式を使用してコンテンツページを作成します。
ステップ3
開発サーバーでローカルプレビューを確認します。
ステップ4
選択したホスティングプラットフォームにデプロイします。
テーマはアイコンの有無にかかわらず動作する LinkCard コンポーネントを提供します。テーマからインポートしてください:
import LinkCard from '@f5-sales-demo/docs-theme/components/LinkCard.astro';prefix:name 構文を使用して icon プロップを追加します。8つのアイコンパックすべてがサポートされています — 完全なカタログはアイコンパッケージのドキュメントを参照してください。
lucide:)carbon:)mdi:)phosphor:)tabler:)f5-brand:)f5xc:)これらのアイコンはマルチカラーで、ライト/ダークモードの色適応に CSS カスタムプロパティを使用します。
hashicorp-flight:)6つのバッジバリアントをインラインでレンダリング:
デフォルト 注記 危険 成功 ヒント 注意バリアント付きの各サイズ:
スモールヒント ミディアム危険 ラージ成功以下の見出しは starlight-heading-badges プラグイン構文を使用しています。
この見出しには、機能が安定していることを示す成功バッジが付いています。
この見出しには、API が実験的であることを示す注意バッジが付いています。
この見出しには、非推奨であることを示す危険バッジが付いています。
この見出しには、新機能であることを示すヒントバッジが付いています。
この見出しには、最近更新されたことを示す注記バッジが付いています。
この見出しには、バリアントが指定されていないデフォルトバッジが付いています。
サイドバーを確認してください:このページには、フロントマター経由で tip バリアントが適用された「New」バッジがあります。
| 機能 | ステータス | 優先度 |
|---|---|---|
| ダークモード | サポート済み | 高 |
| 画像ズーム | サポート済み | 中 |
| Mermaid ダイアグラム | サポート済み | 中 |
| 見出しバッジ | サポート済み | 低 |
| プロパティ | タイプ | デフォルト | 説明 |
|---|---|---|---|
title | string | — | ヘッダーに表示されるページタイトル |
description | string | "" | SEO 用のメタディスクリプション |
sidebar.order | number | 0 | サイドバーでの並び順 |
sidebar.badge | object | null | サイドバーラベルの横に表示されるバッジ |
template | "doc" | "splash" | "doc" | ページレイアウトテンプレート |
以下の画像は starlight-image-zoom プラグインをテストします。クリックしてズームしてください。
