dashboard/docusaurus
Neil MacDougall fc377a0eb2
Extension and other docs (#7551)
2022-11-28 15:04:53 +00:00
..
docs Extension and other docs (#7551) 2022-11-28 15:04:53 +00:00
src Extension and other docs (#7551) 2022-11-28 15:04:53 +00:00
static Documents hierarchy (#6522) 2022-08-22 16:30:44 +02:00
.gitignore
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 Fixed text 2022-08-18 10:27:04 +02:00
sidebars.js Extension and other docs (#7551) 2022-11-28 15:04:53 +00:00
yarn.lock

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.