dashboard/docusaurus
Francesco Torchia f13cf9aed0
Add e2e @components tag
Signed-off-by: Francesco Torchia <francesco.torchia@suse.com>
2024-02-14 15:50:58 +01:00
..
blog chore: fix linter issues 2023-05-04 13:01:15 +02:00
docs Add e2e @components tag 2024-02-14 15:50:58 +01:00
src Ext docs (#8673) 2023-04-17 15:43:16 +01:00
static Fixed header text 2023-03-09 07:08:37 +01:00
.gitignore Created docusaurus setup 2022-07-13 09:05:16 +02:00
README.md initial plugins docs 2022-11-01 08:38:32 -07:00
babel.config.js Fixed code 2022-07-19 08:59:44 +02:00
docusaurus.config.js chore: fix linter issues 2023-05-04 13:01:15 +02:00
package.json revert change (#10217) 2024-01-03 15:59:17 +00:00
sidebars.js Move dashboard container build to internal documentation (#10113) 2023-12-05 12:32:42 -05:00

README.md

Website

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

Note: Docusaurus 2 expected node version >=16.14.

Installation

$ yarn docs:install

Local Development

Note this command will open a web browser on the locally served site (http://localhost:3000)

$ yarn docs: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.

Note this command will open a web browser on the locally served site (http://localhost:3000)

Build

$ yarn docs:build

Adding new documents

Guide for sidebars.js.

Note: We are using sidebars.js file to generate a custom sidebar.

  1. Create a Markdown file, greeting.md, and place it under the docs directory.

  2. Add file name in sidebars.js.