ホーム
BX Sites
BX Sites は、mkdocs や mkdocs-material の精神に倣い、 Markdown から静的なドキュメントサイトを生成する BoxLang モジュールです。
このサイト自体も、このリポジトリの docs/ フォルダ内の Markdown ファイルから BX Sites によってビルドされています。
ご自身でビルドするには はじめに をご覧ください。
ハイライト
- Markdown を入力して、静的 HTML を出力。
docs/フォルダを指定するだけで、site/に完全なサイトが生成されます。ホスティングにサーバーは不要です。 - フォルダ構造がナビゲーション構造。
docs/配下にフォルダとファイルをネストすると、 フロントマターで指定した順序でナビゲーションが自動的に構築されます。 - 3 つの組み込みテーマ。
bootstrap（デフォルト）、material、tailwindの 3 つ。 すべて同じ BoxLang ブランドパレットを使用しており、独自テーマで上書きすることもできます。 - 静的なクライアントサイド検索。 lunr.js を使った検索ボックスと ビルド時に生成される検索インデックスを組み合わせています。mkdocs のデフォルトと同じアプローチで、 サーバー依存なし。
- Markdown の処理は bx-markdown が担当。
BX Sites 自身は Markdown を解析せず、bx-markdown に委譲し、
bxsites.jsonのオプションをそのまま渡します。 - BoxLang 独自のモジュールシステムを基盤にしたプラグインシステム。 プラグインは単なる別の BoxLang モジュールであり、専用の Plugin API を学ぶ必要はありません。
- GitBook または mkdocs から直接移行。
bxSites migrate --source=... --from=gitbook|mkdocsコマンドで、既存の GitBook エクスポートまたは mkdocs プロジェクトを、一つのコマンドで動作する bx-sites プロジェクトに 変換します。
次のステップ
- はじめに - インストール、プロジェクトのスキャフォールド、ビルドと配信
- CLI リファレンス - すべての動詞とオプション
- 設定 -
bxsites.jsonの完全なリファレンス - テーマ - 組み込みテーマと独自テーマの作成方法
- 検索 - 静的検索インデックスの仕組み
- GitHub Pages へのデプロイ - 組み込みの GitHub Actions ワークフロー
- Markdown 拡張機能 - Admonition、脚注、定義リスト、コンテンツタブ、数式、コードアノテーション、Mermaid ダイアグラム
- プラグイン - 独自の BoxLang モジュールで BX Sites を拡張する
- GitBook からの移行 - GitBook エクスポートを一つのコマンドで bx-sites プロジェクトに変換する
- mkdocs からの移行 - mkdocs プロジェクトを一つのコマンドで bx-sites プロジェクトに変換する
- リリース - バージョンポリシーと各リリースの新機能