dashboard/docusaurus
Neil MacDougall 136ae6ad78
Fix broken links on readme and docs homepage (#11161)
* Fix broken links on readme and docs homepage

* Fix lint
2024-06-03 17:37:27 +01:00
..
blog
docs
src
static
.gitignore
README.md
babel.config.js
docusaurus.config.js
package.json
sidebars.js

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.