Giter Club home page Giter Club logo

higress-group.github.io's Introduction

Higress Official Website

CI Status

All website material of https://higress.io.

Quick Start

  1. npm install

  2. npm run start

  3. Visit

localhost:3000/

Build

  1. npm run build

  2. npm run serve

  3. Visit

localhost:3000/

Requirements

Base docusaurus v2.3.1 Node.js version 16.14+

Note for i18n

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.

How To Write Documents

Add a new doc

  1. 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.
  2. Update sidebar.js, add a new entry to the blog in either en-us or zh-cn.

Add a new article for developers

  1. 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.
  2. Update sidebar.js, add a new entry in either en-us or zh-cn.

Add a new blog

  1. 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.
  2. SEO config is required.

SEO

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:

  1. title can not include :
  2. keywords must be a Array
  3. custom_edit_url is a link to the doc in this repo, required.

Note for .md file

  1. Do not use un correct html tag like <img>ใ€<br>, replace with <img /> <br />
  2. If you want show <xx>, replace with &lt;xx&gt;

higress-group.github.io's People

Contributors

johnlanni avatar slievrly avatar ch3cho avatar gengleilei avatar kwtboom avatar laojun avatar 2456868764 avatar specialyang avatar rinfx avatar spacewander avatar liangxiong3403 avatar heimanba avatar weixinx avatar hinsteny avatar fkbqf avatar sjtuzbk avatar ronething avatar hazel0928 avatar katepangliu avatar ruansheng8 avatar tomkerkhove avatar vikizhao156 avatar xunzhuo avatar lynskylate avatar innerpeacez avatar songpengyuan avatar shouao avatar dspo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.