mirror of
https://github.com/dromara/hertzbeat.git
synced 2024-10-23 06:45:24 +08:00
.. | ||
blog | ||
docs | ||
i18n | ||
src | ||
static | ||
versioned_docs/version-v1.5.x | ||
versioned_sidebars | ||
babel.config.js | ||
docusaurus.config.js | ||
LICENSE | ||
package.json | ||
README.md | ||
sidebars.json | ||
versions.json | ||
yarn.lock |
HertzBeat Website
This website is built with Docusaurus.
Installation
yarn install
## yarn install --registry=https://registry.npmmirror.com
I18N
yarn write-translations --locale zh-cn
yarn write-translations --locale en
Local Development
yarn 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.
Build
yarn 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 yarn deploy
OR
USE_SSH=true yarn 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 yarn deploy
Archive Version
yarn 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