メインコンテンツにスキップ
バージョン: Next

Docusaurus統合

O2は、ObsidianのノートをDocusaurusのブログ投稿に変換する際、Docusaurusのブログ機能とマークダウン拡張との互換性を維持しながら変換を行います。

プロジェクト構造

Docusaurusへの変換時、O2は以下の構造に従います:

your-docusaurus-project/
└── blog/
├── YYYY-MM-DD/ # 日付ベースの投稿フォルダ
│ ├── title.md # 変換されたブログ投稿
│ └── assets/ # 投稿ごとの添付ファイル
└── authors.yml # オプション:著者情報

機能

マークダウン変換

O2は、様々なObsidian固有のマークダウン機能をDocusaurus互換形式に自動変換します:

  1. ウィキリンク: [[ノートタイトル]][ノートタイトル](ノート-タイトル)
  2. コールアウト: Docusaurusスタイルのアドモニションに変換
  3. 脚注: 脚注を適切に保持し、フォーマット
  4. コメント: HTMLコメントに変換
  5. フロントマター: Docusaurus固有のフロントマターフィールドを追加

フロントマターの処理

  • 既存のフロントマターを保持
  • 必須Docusaurusフィールドを追加:
    • slug
    • title
    • authors(設定可能)
    • tags(存在する場合)
  • 日付フィールドを適切に処理

ファイル構成

  • より良い構成のための日付ベースフォルダの作成
  • 投稿と共に添付ファイルを保持
  • 様々な日付抽出パターンをサポート

設定

必須設定

  1. Docusaurusパス: Docusaurusプロジェクトの絶対パスを設定

    例: /Users/username/website
  2. 著者: ブログ投稿のデフォルト著者を設定

    形式: 著者1, 著者2

日付抽出パターン

O2はブログ投稿構成のための様々な日付パターンをサポートします:

  1. 基本パターン: YYYY-MM-DD
  2. 時間含む: YYYY-MM-DD-HH-mm
  3. カスタムパターン: 設定を通じて構成可能

使用例

  1. Obsidianで新規ノートを作成:

    ---
    title: Docusaurusを始める
    tags: [docusaurus, チュートリアル]
    ---

    # 始める

    役立つヒントがあります:

    > [!tip]
    > Docusaurusは素晴らしいです!

    詳細は[[インストールガイド]]を確認してください。

    ここに画像があります:![[screenshot.png]]
  2. ノートをreadyフォルダに移動

  3. O2変換コマンドを実行

  4. Docusaurusでの変換後のファイル:

    ---
    title: Docusaurusを始める
    authors: [default-author]
    tags: [docusaurus, チュートリアル]
    slug: docusaurusを始める
    ---

    # 始める

    役立つヒントがあります:

    :::tip
    Docusaurusは素晴らしいです!
    :::

    詳細は[インストールガイド](インストール-ガイド)を確認してください。

    ここに画像があります:![screenshot](./screenshot.png)

トラブルシューティング

  1. フロントマターの問題

    • 必須フィールドが存在するか確認
    • 著者名がauthors.ymlファイルと一致するか確認
    • slug生成が正しいか確認
  2. 画像リンク

    • 画像がブログ投稿フォルダに正しくコピーされているか確認
    • 相対パスが正しいか確認
    • 画像拡張子がサポートされているか確認
  3. 日付処理

    • 日付パターンが設定されたパターンと一致するか確認
    • 日付が有効か確認
    • フォルダ構造が予想される形式と一致するか確認
  4. アドモニション変換

    • コールアウト構文が正しいか確認
    • カスタムコールアウトタイプが正しくマッピングされているか確認
    • Docusaurusでアドモニションスタイルが適用されているか確認

既知の制限事項

  1. 添付ファイルの処理

    • 現在、添付ファイルは投稿と共に保存されます
    • グローバル添付ファイルディレクトリのサポートなし
    • 画像以外の添付ファイルに対する制限的なサポート
  2. MDX互換性

    • 一部のMDX機能は手動調整が必要な場合があります
    • 複雑なJSXコンポーネントはレビューが必要な場合があります
  3. バージョン管理

    • 組み込みバージョン管理のサポートなし
    • バージョン管理されたドキュメントは手動管理が必要