ホーム
docs/ フォルダ(または、"docs" らしくないプロジェクトなら src/)を指定するだけ。ドキュメント、マーケティングサイト、ブログ、その他 Markdown で書けるものなら何でも、検索・i18n・実運用向けの Markdown ツールキットを備えた、高速でテーマ変更可能な静的サイトが手に入ります。
このサイト自体も、このリポジトリの docs/ フォルダ内の Markdown ファイルから
BxSites によってビルドされています。
BxSites はリファレンスドキュメント専用ではなく、汎用の
静的サイトジェネレーターです。マーケティングサイト、ブログ、ナレッジベース、
プロダクトサイト、個人サイト - Markdown で書けるものなら何でも、同じテーマ、
同じ検索、同じ i18n を通して同じようにビルドされます。コンテンツは既定では
docs/ に置きますが、「docs」というよりウェブサイトらしいプロジェクトなら
src/ でも構いません - どちらでもすべてのコマンドは同じように動作します。
docs/ フォルダ - あるいは「docs」というよりウェブサイトらしいプロジェクトなら
src/ - を指定するだけで、site/ に完全なサイトが生成されます。ホスティング
にサーバーは不要です。
docs/(または src/)配下にフォルダとファイルをネストすると、フロントマターで
指定した順序でナビゲーションが自動的に構築されます。
bootstrap、material、tailwind、そして Docsy・Stripe・Docusaurus・
Just the Docs・VuePress・GitBook・Notion にインスパイアされた 7 個を加えた
フルギャラリー - すべて独自テーマで上書き可能です。
あいまい検索・前方一致検索に対応した MiniSearch 駆動の検索ボックスに加え、
Cmd/Ctrl+K コマンドパレットも搭載 - build 時に生成される検索インデックスと
連携し、サーバー依存なし。
docs/blog/posts/ に投稿を置くだけで、著者・カテゴリ・年別アーカイブ・
RSS フィード・投稿ごとのアイキャッチ画像が設定不要で手に入ります。
フィンガープリント付き CSS/JS バンドリングとレスポンシブ画像が標準搭載、 さらに Bootstrap、highlight.js、Alpine.js、lunr.js、(オプトインで)Mermaid もすべてベンダリング済み - ビルドされたサイトはデフォルトで外部への リクエストが一切発生しません。
プラグインは単なる別の BoxLang モジュールです - 専用の Plugin API を学ぶ 必要はありません。
install:plugin と install:theme は、公開済みパッケージをプロジェクトに
直接ダウンロードします - ForgeBox の bxsites-plugins と bxsites-themes
から探せます。
theme:import --source=mkdocs|jekyll|hugo は、他のジェネレーター自身の
テーマテンプレートを bx-sites のスキャフォールドに変換します - ゼロから
書き直す代わりに、そこから作り込めます。
bxSites migrate --from=gitbook|mkdocs|markdown-zip|notion は、既存の
エクスポートやプロジェクトを、一つのコマンドで動作する bx-sites プロジェクトに
変換します。
bxSites deploy は、ビルドしたサイトを S3、Azure、GCS、Firebase、FTP/SFTP、
rsync、Netlify、Vercel、Cloudflare Pages、GitHub Pages に直接デプロイします -
bxSites package なら単一のアーカイブに zip 圧縮することもできます。
{{ dotted.path }} は bxsites.yaml 自身の variables ブロックから値を
取得し、{{ $name(args) }} は Markdown から直接、小さな BoxLang ヘルパー
関数を呼び出します - プラグインも配線も不要です。
テーブル、ボタン、プロンプト、展開可能セクション、タブ、埋め込み OpenAPI 仕様 - 素の Markdown の上に構築された GitBook スタイルのブロックライブラリです。
読むだけでなく、実際に見てみる
BxSites 自身の Markdown ツールキットが、まさにこのホームページ上で動いています - スクリーンショットではなく、本物です:
install-bx-module bx-sites
bxSites new
bxSites serve
note、tip、warning、danger など、12 種類の標準 Admonition タイプ -
それぞれ専用のアクセントカラーを持ち、折りたたみ可能な ??? バリアントも
あります。Markdown 拡張機能 を参照してください。
グループ化されたコードタブ、KaTeX 数式、Mermaid ダイアグラム、脚注、 定義リストがすべて標準搭載です - 詳しくは Markdown 拡張機能 を参照してください。
次のステップ
インストール、プロジェクトのスキャフォールド、ビルドと配信。
すべての動詞とオプション。
bxsites.yaml の完全なリファレンス。
Admonition、タブ、カード、コールアウト、数式、Mermaid ダイアグラム。
投稿、著者、カテゴリ、アーカイブ、RSS、下書き、統計ページ。
自動画像リサイズ/WebP 変換と、フィンガープリント付き CSS/JS バンドリング。
deploy/package コマンドと、組み込みの GitHub Actions ワークフロー。
バージョニングポリシーと各リリースの新機能。
サイト構築の手伝いが必要ですか?
BxSites は無料でオープンソースです - ですが、開発チーム自身に作業を 任せたい場合は、Ortus Solutions が ドキュメントサイト、移行、その他 BxSites で構築されたあらゆる静的サイトに 関するプロフェッショナルサービス・コンサルティングを提供しています。
