Libx サンプルドキュメント

フロントマターリファレンス

ドキュメントファイルで利用可能なフロントマタープロパティの完全なリファレンス。このドキュメントシステムは、必須メタデータのみに焦点を当てたミニマリストなアプローチを使用しています。

必須プロパティ

title

  • 型: string
  • 説明: ドキュメントのタイトル、ナビゲーションとページヘッダーに表示される
  • 使用法: ドキュメント内で説明的かつ一意である必要があります
title: "入門ガイド"

description

  • 型: string
  • 説明: SEOメタタグとコンテンツプレビューに使用される簡潔な説明
  • 使用法: 最適なSEOのため50-160文字である必要があります
description: "ドキュメントシステムの使い方を学ぶ"

自動機能

このドキュメントシステムは、従来手動でフロントマター設定が必要だった多くの側面を自動的に処理します：

ナビゲーション

  • 前/次リンク: ファイル構造と番号付けに基づいて自動生成
  • カテゴリ整理: ディレクトリ構造から派生
  • 順序付け: ファイル命名規則に基づく（01-、02-など）

メタデータ

  • 公開日: Gitヒストリーを通じて管理
  • 著者情報: Gitコミットを通じて追跡
  • 更新日: ファイル変更に基づいて自動更新

ファイル整理

ディレクトリ構造

コンテンツの整理はファイルシステム構造を通じて処理されます：

src/content/docs/[lang]/[version]/[category]/[document].mdx
  • カテゴリはディレクトリ名から自動検出
  • 順序付けは数字接頭辞で制御（01-、02-など）
  • ナビゲーションはファイル構造に基づいて生成

命名規則

ドキュメントの順序を制御するために番号接頭辞を使用：

01-getting-started.mdx    # 最初のドキュメント
02-installation.mdx       # 2番目のドキュメント
03-configuration.mdx      # 3番目のドキュメント

カテゴリ

このシステムで使用される標準カテゴリ：

  • 01-guide/ - ステップバイステップチュートリアルと入門コンテンツ
  • 02-components/ - UIコンポーネントドキュメントと例
  • 03-advanced/ - 高度なトピックとカスタマイズ
  • 04-reference/ - APIリファレンスと詳細仕様

使用例

ほとんどのドキュメントに推奨される最小限のフロントマター：

---
title: "あなたのドキュメントタイトル"
description: "このドキュメントが扱う内容の簡潔な説明"
---

このシンプルなアプローチは、システムの自動機能を整理とナビゲーションに活用しながら、すべての必須メタデータを提供します。

ベストプラクティス

タイトルガイドライン

  • 説明的でキーワードリッチなタイトルを使用
  • タイトルは簡潔で情報に富むものに
  • 各セクション内でタイトルが一意であることを確認

説明ガイドライン

  • 最適なSEOのため50-160文字の説明を維持
  • 明確で実行可能な説明を記述
  • ユーザーが何を学ぶか、何を達成するかに焦点

ファイル整理

  • 順序制御に番号接頭辞を使用（01-、02-など）
  • 関連コンテンツを適切なディレクトリにグループ化
  • すべてのドキュメント間で一貫した命名規則に従う

このミニマリストなアプローチは、すべての必須情報を効率的にキャプチャしながら、メンテナンスオーバーヘッドを削減します。

追加考慮事項

多言語サポート

各言語で同じ構造とフロントマターパターンを維持：

# 日本語版
---
title: "コンポーネント概要"
description: "利用可能なUIコンポーネントの完全ガイド"
---

# 英語版
---
title: "Component Overview"  
description: "Complete guide to available UI components"
---

バージョン管理

バージョン間で一貫したフロントマター構造を保持：

# v1とv2で同じ形式
---
title: "基本的な使用法"
description: "基本機能の使用方法"
---

特殊ケース

一部の特殊なドキュメントでは追加の考慮が必要な場合があります：

ランディングページ

---
title: "プロジェクト名"
description: "プロジェクトの主要機能と利点の概要"
---

APIリファレンス

---
title: "API リファレンス"
description: "利用可能なすべてのAPIエンドポイントと使用例"
---

トラブルシューティング

---
title: "トラブルシューティング"
description: "一般的な問題とその解決方法"
---

従来の複雑なフロントマターとの比較

従来のアプローチ（使用しない）

---
title: "ドキュメント"
description: "説明"
order: 3
category: "guide"  
categoryOrder: 1
prev:
  text: "前のページ"
  link: "/prev-page"
next:
  text: "次のページ"  
  link: "/next-page"
author: "著者名"
pubDate: 2024-01-01
updatedDate: 2024-01-15
sidebar: true
toc: true
---

新しいシンプルなアプローチ（推奨）

---
title: "ドキュメント"
description: "説明"
---

新しいアプローチでは：

  • orderとcategoryはファイル構造から自動決定
  • prevとnextは自動生成
  • authorと日付はGitから自動取得
  • sidebarとtocはシステム設定で制御

移行ガイド

既存の複雑なフロントマターから移行する場合：

  1. 必須フィールドのみ保持: titleとdescriptionのみ残す
  2. ファイル構造で整理: 番号接頭辞とディレクトリでナビゲーションを制御
  3. 不要フィールドを削除: order、category、author、日付フィールドを削除
  4. テストと検証: ナビゲーションとメタデータが正しく動作することを確認

このシンプルなアプローチにより、メンテナンスが容易になり、自動化の利点を最大限に活用できます。