JMeter Docs

JMeter 文档

使用 Astro + Starlight 构建的 Apache JMeter 社区维护文档

docs.jmeter.ai

---

免责声明： 这是独立的社区资源，与 Apache Software Foundation 没有关联。

功能

• 全文搜索：由 Pagefind 提供支持
• 深色模式：可检测系统偏好设置
• 条理清晰的侧边栏：用户手册、参考、扩展、法律信息
• 适合大模型的文本导出（llms.txt / llms-full.txt）
• 自定义着陆页：包含终端风格主视觉、指标栏和便当盒布局
• SEO 优化：包含结构化数据（FAQ、HowTo 架构）

快速开始

前提条件

• 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	生成适合大模型的文本导出

面向 AI Agent 的 Markdown

每个预渲染的文档页面（网站首页除外）都有对应的 Markdown 文件：在页面 URL 后附加 index.md（例如 https://docs.jmeter.ai/user-manual/best-practices/index.md），或者在请求页面 URL 时添加 Accept: text/markdown 标头，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 重写规则，仅需配置一次：

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。

贡献

欢迎贡献！欢迎提交 Pull Request。

1. Fork 此仓库
2. 创建功能分支（git checkout -b feature/amazing-feature）
3. 使用 Conventional Commits 提交更改
4. 将更改推送到分支（git push origin feature/amazing-feature）
5. 创建 Pull Request

重要：MDX 文件是自动生成的

src/content/docs/**/*.mdx 文件是由 tools/convert.mjs 根据上游 Apache JMeter xdocs/ XML 生成的产物。每晚运行的工作流（.github/workflows/sync-upstream.yml）会重新生成这些文件并创建同步 PR。

直接编辑 MDX 文件会在下一次同步运行时被覆盖。如需对文档内容进行持久更改：

• 优先修复转换器 tools/convert.mjs，让更改适用于所有生成的页面并在同步后保留。
• 或者将更改贡献到上游 apache/jmeter 的 xdocs/，让更改自然同步下来。
• 或者提交 issue 描述所需更改，让维护者决定最佳处理方式。

非生成文件（组件、样式、工具、测试、配置）的更改不受同步影响，可以直接编辑。

许可证

本项目根据 Apache License 2.0 版（以下简称“许可证”）授权； 除非遵守许可证，否则不得使用此文件。 你可以在以下网址获取许可证副本：

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

除非适用法律要求或书面同意，否则根据许可证分发的软件均按“原样”提供， 不附带任何明示或暗示的保证或条件。 请参阅许可证，了解管理权限和限制的具体语言。

Apache JMeter 是 The Apache Software Foundation 的商标。本项目未获 ASF 认可，也与 ASF 无关联。