コンテンツにスキップ

コンポーネント

各アサイドタイプは、デフォルトのタイトルとともに ::: フェンス構文を使用します。

アサイド内のリッチコンテンツ

Section titled “アサイド内のリッチコンテンツ”

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);
}

これは概要タブのコンテンツです。基本的なタブのレンダリングを確認するためのプレーンテキストを含んでいます。

最初のタブのプレーンな段落コンテンツです。

これらの2つのタブグループは syncKey="pkg" を共有しています。一方のグループでタブを選択すると、もう一方も更新されます。

インストールコマンド:

Terminal window
npm install @f5-sales-demo/docs-theme

実行コマンド:

Terminal window
npm run dev
  1. リポジトリをクローンする

    Terminal window
    git clone https://github.com/example/repo.git
    cd repo
  2. 依存関係をインストールする

    Terminal window
    npm install
  3. 開発サーバーを起動する

    Terminal window
    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つのアイコンパックすべてがサポートされています — 完全なカタログはアイコンパッケージのドキュメントを参照してください。

これらのアイコンはマルチカラーで、ライト/ダークモードの色適応に CSS カスタムプロパティを使用します。

インラインバッジのバリアント

Section titled “インラインバッジのバリアント”

6つのバッジバリアントをインラインでレンダリング:

デフォルト 注記 危険 成功 ヒント 注意 スモール ミディアム ラージ

バリアント付きの各サイズ:

スモールヒント ミディアム危険 ラージ成功

以下の見出しは starlight-heading-badges プラグイン構文を使用しています。

この見出しには、機能が安定していることを示す成功バッジが付いています。

この見出しには、API が実験的であることを示す注意バッジが付いています。

この見出しには、非推奨であることを示す危険バッジが付いています。

この見出しには、新機能であることを示すヒントバッジが付いています。

この見出しには、最近更新されたことを示す注記バッジが付いています。

この見出しには、バリアントが指定されていないデフォルトバッジが付いています。

サイドバーを確認してください:このページには、フロントマター経由で tip バリアントが適用された「New」バッジがあります。

機能ステータス優先度
ダークモードサポート済み
画像ズームサポート済み
Mermaid ダイアグラムサポート済み
見出しバッジサポート済み
プロパティタイプデフォルト説明
titlestringヘッダーに表示されるページタイトル
descriptionstring""SEO 用のメタディスクリプション
sidebar.ordernumber0サイドバーでの並び順
sidebar.badgeobjectnullサイドバーラベルの横に表示されるバッジ
template"doc" | "splash""doc"ページレイアウトテンプレート

以下の画像は starlight-image-zoom プラグインをテストします。クリックしてズームしてください。

GitHub アバター

  • ディレクトリsrc/
    • ディレクトリcontent/
      • ディレクトリdocs/
        • index.mdx
        • 01-environment-variables.mdx
        • 02-build-pipeline.mdx
        • 03-astro-config.mdx
        • 04-logo.mdx
        • 05-colors.mdx
        • 07-typography.mdx
        • 08-code-blocks.mdx
        • 09-components.mdx このページ
        • 10-mermaid.mdx
        • 11-footer.mdx
        • 12-style-enhancement-guide.mdx
    • ディレクトリplugins/
      • remark-mermaid.mjs
  • ディレクトリstyles/
    • custom.css
  • astro.config.mjs
  • package.json
  • ボーダー左の色はアサイドバリアントごとに異なる(青、紫、黄、赤)
  • アサイドの背景色はライトモードとダークモードの両方で視認可能
  • ボックスシャドウは各アサイドの周囲に微妙だが視認可能
  • すべてのアサイドに角丸(0.75rem)が適用されている
  • タブのアクティブインジケーターの色はアクセントカラーを使用
  • ステップコネクターラインは番号付きステップ間で視認可能
  • 同期タブはグループを切り替えても同期を維持する
  • タブ内のコードブロックは適切なシンタックスハイライトでレンダリングされる
  • カードのボーダー色はライトモードとダークモードで適応する
  • カードのホバー背景エフェクトが視認可能
  • LinkCard の矢印アイコンの色はアクセントカラーと一致する
  • スタガーレイアウトは交互のカードを垂直にオフセットする
  • アイコンはカードヘッダー内で正しくレンダリングされる
  • バッジの背景色はバリアントごとにダークモードとライトモードで異なる
  • ダークモードのバッジはディープトーンを使用(red-4、jade-4、tangerine-4、eggplant-4、bay-4)
  • ライトモードのバッジはライトトーンを使用(red-1、jade-1、tangerine-1、eggplant-1、bay-1)
  • 見出しバッジは見出しテキストとインラインで整列する
  • サイドバーバッジはページラベルの横にレンダリングされる
  • テーブルのボーダー色はライトモードとダークモードで適応する
  • テーブルのヘッダー行は明確な背景を持つ
  • 画像ズームオーバーレイはクリックで動作する(starlight-image-zoom)
  • FileTree の背景はテーマに適した色を使用する
  • アイコンは現在のテキストカラーを継承する