dashboard/docusaurus
Phillip Rak 2728e1b85b Fix spelling
Signed-off-by: Phillip Rak <rak.phillip@gmail.com>
2022-09-16 13:34:07 -07:00
..
docs Fix spelling 2022-09-16 13:34:07 -07:00
src Tweak docs landing page (#6746) 2022-08-25 13:31:22 +01:00
static Documents hierarchy (#6522) 2022-08-22 16:30:44 +02:00
.gitignore Created docusaurus setup 2022-07-13 09:05:16 +02:00
README.md Documents hierarchy (#6522) 2022-08-22 16:30:44 +02:00
babel.config.js Fixed code 2022-07-19 08:59:44 +02:00
docusaurus.config.js Tweak docs landing page (#6746) 2022-08-25 13:31:22 +01:00
package.json Fixed text 2022-08-18 10:27:04 +02:00
sidebars.js fixed typo in getting started (#6821) 2022-09-07 13:23:13 +01:00
yarn.lock Created docusaurus setup 2022-07-13 09:05:16 +02: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 generated custome sidebar.

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

  2. Add file name in sidebars.js.