website

package
v0.87.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 6, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

README

Website

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

Installation
$ yarn
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

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> 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.

Documentation

Overview

Package website embeds the docs website for the server subcommand. Docs are served at /docs similar to how the ui is served at /ui.

Index

Constants

View Source
const OutputPath = "build"

Output must be the relative path to where the build tool places the static site index.html file.

Variables

View Source
var Dist embed.FS

Functions

func Root

func Root() fs.FS

Root returns the static site root directory.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL