Higress Official Website

All website material of https://higress.io

Build instruction

Docker deploy (Recommand)

Docker build the target image.

docker build -t higress-docsite .

Docker run the target image.

docker run -p 8080:8080 higress-docsite

Now you can view the changed document in your local machine.

localhost:8080/

Note: When the dependencies changes, the code owners of this project should rebuild the higress-docsite-base by Dockerfile named Dockerfile-Base.

Local deploy

higress-group.github.io is powered by docsite.please read https://docsite.js.org . If your version of docsite is less than 1.3.3, please upgrade to at least 1.3.3,1.3.8 is recommended.

Please also make sure your node version is 8.x, versions higher than 8.x is not supported by docsite yet.

Run npm install docsite -g to install the dev tool.
Run npm i in the root directory to install the dependencies.
Run docsite start in the root directory to start a local server, you will see the website in 'http://127.0.0.1:8080'.
Run docsite build to build source code.
Verify your change locally: python -m SimpleHTTPServer 8000, when your python version is 3 use :python3 -m http.server 8000 instead.

If you have higher version of node installed, you may consider nvm to allow different versions of node coexisting on your machine.

Follow the instructions to install nvm
Run nvm install v8.16.0 to install node v8
Run nvm use v8.16.0 to switch the working environment to node v8
Run npm install docsite -g

Make sure npm and docsite are configured in the environmet configuration of os . eg: /etc/profile or .bash_profile of Macos

Then you are all set to run and build the website. Follow the build instruction above for the details.

How To Write Documents

Add a new doc

Add new .md file under docs/en-us or docs/zh-cn. Corresponding to Chinese file and English file , and the Chinese and English file names should be consistent.
Update site_config/docs.js, add a new entry to the blog in either en-us or zh-cn.
Run docsite start locally to verify the blog can be displayed correctly.
Send the pull request contains the .md and doc.js only.

Add a new article for developers

Add new .md file under docs/en-us/developers or docs/zh-cn/developers, the file name should end up with _dev.md. Note that the suffix _dev is necessary.
Update site_config/develop.js, add a new entry in either en-us or zh-cn.
Run docsite start locally to verify the article can be displayed correctly.
Send the pull request contains the *_dev.md and develop.js only.

Add a new blog

Add new .md file under blog/en-us or blog/zh-cn. Corresponding to Chinese file and English file , and the Chinese and English file names should be consistent.
~~Update site_config/blog.js, add a new entry to the blog in either en-us or zh-cn.~~
Run docsite start locally to verify the blog can be displayed correctly.
Send the pull request contains the .md ~~and blog.js~~ only.
SEO config is required.

notice : Blog documents will be automatically sorted by time, without menu configuration
Set 'hidden' to 'true' for documents you don't want to display temporarily`

SEO

the type is :

---
hidden: false
title: title
keywords: keywords1,keywords2
description: some description
author: author name
date: 2018-12-29
---

Others

If you want to add search in site，see https://docsite.js.org/zh-cn/docs/search.html
This is docsite docs :https://docsite.js.org/zh-cn/docs/path.html

spacewander / higress-group.github.io