JMeter Docs

JMeter Docs

Astro + Starlight で構築された、Apache JMeter のコミュニティ運営ドキュメント

docs.jmeter.ai

---

免責事項： これは独立したコミュニティリソースであり、Apache Software Foundation とは関係ありません。

特長

• Pagefind を利用した全文検索
• システム設定の検出に対応したダークモード
• 整理されたサイドバー：ユーザーマニュアル、リファレンス、拡張、法的情報
• LLM に適したテキストエクスポート（llms.txt / llms-full.txt）
• ターミナル風のヒーロー、メトリクス表示、ベントーグリッドを備えたカスタムランディングページ
• 構造化データ（FAQ、HowTo スキーマ）によるSEO 最適化

はじめに

前提条件

• Node.js 18+
• npm

インストール

npm install

開発

npm run dev

ビルド

npm run build

本番ビルドのプレビュー

npm run preview

スクリプト

スクリプト	説明
npm run dev	開発サーバーを起動します
npm run build	llms-full.txt を生成してからサイトをビルドします
npm run preview	本番ビルドをローカルでプレビューします
npm test	単体テストを実行します
npm run test:watch	ウォッチモードでテストを実行します
npm run test:coverage	カバレッジレポート付きでテストを実行します
npm run convert	上流の JMeter ドキュメントを Starlight 形式に変換します
npm run generate-llms-full	LLM に適したテキストエクスポートを生成します

AI エージェント向け Markdown

プリレンダリングされたすべてのドキュメントページ（サイトのホームページを除く）には、対応する Markdown ファイルがあります。ページ URL の末尾に index.md を追加するか（例：https://docs.jmeter.ai/user-manual/best-practices/index.md）、Accept: text/markdown ヘッダーを付けてページ URL にリクエストしてください。CDN がリクエストを .md ファイルに書き換えます。ブラウザーへの影響はありません。このルールは、Accept に text/html が含まれない場合にのみ適用されます。

index.md ファイルは、ビルド時に scripts/generate-page-markdown.mjs（pnpm build の一部）によって生成され、public/_headers を介して Content-Type: text/markdown で提供されます。また、Accept: text/markdown のマッピングは、以下のコマンドで一度だけ設定する Cloudflare ゾーン URL Rewrite Rule です。

pnpm setup-markdown-rule   # needs CLOUDFLARE_API_TOKEN + CLOUDFLARE_ZONE_ID

index.md ファイルは build スクリプトによって生成されます。本番ビルドでは pnpm run build を実行する必要があります（astro build のみでは不十分です）。そうしないと Markdown リンクが 404 になります。ジェネレーターは、何も書き込めなかった場合にゼロ以外の終了コードを返します。

詳しくは scripts/setup-markdown-rule.mjs と public/llms.txt をご覧ください。

コントリビューション

コントリビューションを歓迎します！お気軽にプルリクエストを送ってください。

1. リポジトリをフォークします
2. フィーチャーブランチを作成します（git checkout -b feature/amazing-feature）
3. Conventional Commits に従って変更をコミットします
4. ブランチにプッシュします（git push origin feature/amazing-feature）
5. プルリクエストを作成します

重要：MDX ファイルは生成されます

src/content/docs/**/*.mdx ファイルは、上流の Apache JMeter xdocs/ XML から tools/convert.mjs によって生成される生成物です。毎晩実行されるワークフロー（.github/workflows/sync-upstream.yml）でファイルが再生成され、同期 PR が作成されます。

**MDX ファイルを直接編集しても、次回の同期実行時に上書きされます。**ドキュメントの内容を永続的に変更するには、次の方法があります。

• コンバーターの tools/convert.mjs を修正する方法がおすすめです。変更がすべての生成ページに適用され、同期後も維持されます。
• **または、**変更を apache/jmeter の xdocs/ に取り込んでもらうと、自然に反映されます。
• **または、**希望する変更について説明する issue を作成すると、メンテナーが最適な方法を判断できます。

生成対象ではないファイル（コンポーネント、スタイル、ツール、テスト、設定）への変更は同期の影響を受けないため、直接編集できます。

ライセンス

このファイルは Apache License, Version 2.0（「ライセンス」）の下でライセンスされています。 ライセンスに従わない限り、このファイルを使用することはできません。 ライセンスのコピーは、次の場所から入手できます。

http://www.apache.org/licenses/LICENSE-2.0

適用される法律で義務付けられている場合、または書面で合意されている場合を除き、 ライセンスの下で配布されるソフトウェアは、明示的か黙示的かを問わず、いかなる種類の保証もなく、 「現状のまま」提供されます。ライセンスに基づく権利および制限については、 ライセンスをご確認ください。

Apache JMeter は The Apache Software Foundation の商標です。このプロジェクトは ASF による承認を受けておらず、ASF と提携していません。