跳到主要内容
版本：dev

文档说明

对于任何类型的软件来说，良好的文档都是至关重要的。任何能够改进 HertzBeat 文档的贡献都是受欢迎的。

获取文档项目​

HertzBeat 项目的文档在 git 仓库 home 目录 中维护。

首先，您需要将文档项目 fork 到您自己的 github 仓库，然后将文clone到您的本地计算机。

git clone git@github.com:<your-github-user-name>/hertzbeat.git

预览和生成静态文件​

此网站使用 node 进行编译，使用 Docusaurus 框架组件。

  1. 下载并安装 nodejs (版本 18.8.0)
  2. 将代码克隆到本地 git clone git@github.com:apache/hertzbeat.git
  3. 在home目录下运行 pnpm install 来安装所需的依赖库。
  4. 在home目录下运行 pnpm start，您可以访问 http://localhost:3000 查看站点的英文模式预览
  5. 在home目录下运行 pnpm start-zh-cn，您可以访问 http://localhost:3000 查看站点的中文模式预览
  6. 若要生成静态网站资源文件，请运行 pnpm build。构建的静态资源位于 build 目录中。

文档格式检验​

在 Apache HertzBeat 中，所有的 MD 文章都要通过 MD 的 CI 检测才能够合并，目的是为了保持文档官网的美观和文章格式的一致性。

在您编写了相关 MD 文章之后，您可以在本地执行以下命令，预先检查 MD 的文章内容是否符合要求，减少 review 的工作量，节省您的时间：

cd home && pnpm install

pnpm md-lint

# 如果文档错误，您可以使用 pnpm md-lint-fix 修复
pnpm md-lint-fix

MD 文章的相关格式规则您可以参考：Markdown-lint-rules 项目中的 MD 格式配置文件：.markdownlint-cli2.jsonc

目录结构​

|-- docs
|-- blog   
|-- i18n
|   `-- zh-CN  // 中文国际化
|       |-- code.json
|       |-- docusaurus-plugin-content-blog
|       |-- docusaurus-plugin-content-docs
|       `-- docusaurus-theme-classic
|-- resource  // 静态资源文件
|-- src
|   |-- theme
|   |-- css
|   |-- js
|   |-- pages
|   |   |-- components
|   |   |-- index.js
|   |-- constants.js
|-- static // 图片静态资源
|   |-- img  //
|   |   |-- blog // 博客图片
|   |   |-- docs // 文档图片
|   |   |-- home // 产品图片
|   |   |-- icons // 图标
|-- docusaurus.config.js
|-- sidebars.js // 文档侧边栏菜单配置

写一篇博客​

文章放在 blog/ 下，翻译版本放在 i18n/<语种>/docusaurus-plugin-content-blog/，文件名保持一致。

---
title: Apache HertzBeat™ 1.8.0 版本发布公告
author: Apache HertzBeat Community
author_url: https://github.com/apache/hertzbeat
tags: [releases]
description: Apache HertzBeat 1.8.0 带来 AI 对话与 MCP 工具、日志监控，以及大幅性能提升。
cover_headline: Apache HertzBeat 1.8.0
---
  • tags —— 第一个必须是 blog/tags.yml 里定义的分类之一（releases、engineering、 tutorials、community），博客列表页的分类筛选依赖它。后面可以再加自由主题标签。
  • description —— 一到两句话。它同时是卡片摘要和搜索引擎摘要。不填的话 Docusaurus 会取正文第一段，通常是问候语或小标题。
  • cover_headline —— 可选。博客列表会为每篇文章渲染统一视觉风格的封面，这个字段 设置封面上的大标题（例如 Welcome Bob）。不填则自动从标题里的版本号或 被监控产品名推导。
  • cover_kicker —— 可选。生成封面上的小胶囊徽章文字（例如 New Committer）， 不填默认用分类英文名。封面文字各语言统一用英文，保持视觉一致。
  • image —— 可选。真实封面图，配置后完全替代生成式封面。

规范​

文件的命名规范​

全部由小写，数字，下划线和破折号组成。

正例：render-dom.js / signup.css / index.html / company-logo.png / hertz_beat.md

反例：renderDom.js / UserManagement.html

资源路径​

图片资源统一放在 static/img/{模块名称} 下

css 和其他样式文件放在 src/css 目录中。

页面内容修改​

所有页面文档都可以通过底部的'编辑此页面'按钮直接跳转到相应的 github 资源修改页面。