History

Jan Larwig 9945b68a06 doc: readme overhaul and azure sponsorship (#2826 ) * new readme structure * add adopters file * add microsoft sponsorship * add reference to adopter file * add gopher slack invite link * slightly rephrase nightly image section * add sponsor request for action * better formatting for contributor wall * add longer wait time for stale PRs and issues and allow for exemption through bug and high-priority labels * apply review suggestion Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk> --------- Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk>		2024-10-27 12:12:46 +00:00
..
docs	doc: readme overhaul and azure sponsorship (#2826 )	2024-10-27 12:12:46 +00:00
src/css	docs: upgrade to docusaurus 3.1.0 (#2388 )	2024-01-26 12:07:01 +00:00
static	doc: readme overhaul and azure sponsorship (#2826 )	2024-10-27 12:12:46 +00:00
versioned_docs	doc: readme overhaul and azure sponsorship (#2826 )	2024-10-27 12:12:46 +00:00
versioned_sidebars	add new docs version 7.7.x	2024-10-01 11:15:41 +02:00
.gitignore	docs: restructure all options and flags (#2747 )	2024-08-20 10:40:27 +02:00
README.md	feat: Added renovate configuration (#2377 )	2024-01-20 19:51:34 +00:00
babel.config.js	Migrate existing documentation to Docusaurus	2020-11-05 15:36:27 +00:00
docusaurus.config.js	fix search and add some additional options for better usability	2024-05-09 16:02:21 +02:00
package.json	chore(deps): update dependency @easyops-cn/docusaurus-search-local to ^0.45.0	2024-10-13 19:43:24 +02:00
sidebars.js	docs: restructure all options and flags (#2747 )	2024-08-20 10:40:27 +02:00
versions.json	add new docs version 7.7.x	2024-10-01 11:15:41 +02:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

npm install

Local Development

npm start

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

Build

npm 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 npm 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.