Files
hertzbeat/home
2026-08-14 10:44:48 +08:00
..
2022-02-02 22:49:50 +08:00

HertzBeat Website

This website is built with Docusaurus.

Installation

pnpm install
## pnpm install --registry=https://registry.npmmirror.com

I18N

pnpm write-translations --locale zh-cn

pnpm write-translations --locale en

Local Development

pnpm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Writing Blog Posts

Add a concise description to the front matter of new blog posts. It is used for blog cards and page metadata, so it should summarize the article rather than repeat its title, salutation, or first section heading.

---
title: Apache HertzBeat 1.8.0 Release
description: Apache HertzBeat 1.8.0 adds AI tooling, new monitoring integrations, and major performance improvements.
---

Aim for one sentence of roughly 100160 characters in English or 5080 characters in Chinese. Localized posts should provide a localized description.

Team Page

Member

Update the member information in src/pages/team/data/member.json File.

Contributor

Please refer to the All Contributors to auto add contributor.

pnpm all-contributors generate

Use generate to read the contributors list from .all-contributorsrc file and update the contributor tables specified by the files key.

Avatar

pnpm github-avatar

This command will fetch the base64 string of the GitHub avatar from file src/pages/team/data/member.json and .all-contributorsrc, and store the result in the src/pages/team/data/ directory. The operation might take a little while.

Build

pnpm build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true pnpm run deploy
OR
USE_SSH=true pnpm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Deployment to Gitee

GITHUB_HOST=gitee.com USE_SSH=true pnpm run deploy

Archive Version

pnpm docusaurus docs:version v1.5.x

Directory Structure

|-- docs
|-- blog   
|-- i18n
|   `-- zh-CN  // internationalized chinese
|       |-- code.json
|       |-- docusaurus-plugin-content-blog
|       |-- docusaurus-plugin-content-docs
|       `-- docusaurus-theme-classic
|-- resource  // static resource file
|-- src
|   |-- theme
|   |-- css
|   |-- js
|   |-- pages
|   |   |-- components
|   |   |-- index.js
|   |-- constants.js
|-- static // picture static resource
|   |-- img  //
|   |   |-- blog // blog picture
|   |   |-- docs // document picture
|   |   |-- home // product picture
|   |   |-- icons // icon
|-- docusaurus.config.js
|-- sidebars.js // document sidebar menu configuration