All website material of https://higress.io.
-
npm install
-
npm run start
-
Visit
localhost:3000/
-
npm run build
-
npm run serve
-
Visit
localhost:3000/
Base docusaurus v2.3.1 Node.js version 16.14+
For now, we use docusaurus v2.3.1
, and there is a problem with defaultLocale
in docusaurus.config.js
. We can't deploy site like https://my-site
, see this.
It will be solved perfectly in v2.4
, stay tuned.
Please be noted that locale switching function doesn't work if you start the website in development mode using npm run start
or npm run start-en
. Please run it in production mode using the build-and-serve process to enable the locale switching function.
- Add new .md file under i18n/en-us/docusaurus-plugin-content-docs/current or i18n/zh-cn/docusaurus-plugin-content-docs/current. Corresponding to Chinese file and English file , and the Chinese and English file names should be consistent. Due to the special reasons of the current i18n implementation, you also need to add a stub file with the same name in the docs directory.
- Update sidebar.js, add a new entry to the blog in either en-us or zh-cn.
- Add new .md file under i18n/en-us/docusaurus-plugin-content-docs/current/developers or i18n/zh-cn/docusaurus-plugin-content-docs/current/developers, the file name should end up with _dev.md. Note that the suffix _dev is necessary. Due to the special reasons of the current i18n implementation, you also need to add a stub file with the same name in the docs directory.
- Update sidebar.js, add a new entry in either en-us or zh-cn.
- Add new .md file under i18n/en-us/docusaurus-plugin-content-blog/current or i18n/zh-cn/docusaurus-plugin-content-blog/current. Corresponding to Chinese file and English file , and the Chinese and English file names should be consistent.
SEO
config is required.
the type is :
---
title: title
keywords: [keywords1,keywords2]
description: some description
author: author name
date: 2018-12-29
custom_edit_url: https://github.com/higress-group/higress-group.github.io/blob/main/i18n/en/docusaurus-plugin-content-blog/30-line-wasm.md
---
Note:
title
can not include:
keywords
must be aArray
custom_edit_url
is a link to the doc in this repo, required.
- Do not use un correct html tag like
<img>、<br>
, replace with<img /> <br />
- If you want show
<xx>
, replace with<xx>