dashboard/docusaurus
Cody Jackson bbb7eebc90 Removing nuxt 2023-03-03 11:49:26 +00:00
..
docs Removing nuxt 2023-03-03 11:49:26 +00:00
src Very minor Extension docs changes (#8323) 2023-03-02 17:26:41 +00: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 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 Extension and other docs (#7551) 2022-11-28 15:04:53 +00:00
package.json Add `--frozen-lockfile` for `yarn install` for CI workflows (#7412) 2023-01-10 10:40:02 -05:00
sidebars.js Removing nuxt 2023-03-03 11:49:26 +00:00
yarn.lock Bump json5 from 2.2.1 to 2.2.3 in /docusaurus (#7860) 2023-01-17 17:54:28 +00: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.