dashboard/docusaurus
Alexandre Alves b0aba31dc8
Small fixes for docs and extensions workflow tests (#12704)
* small fix extensions workflow tests + update docs for extensions

* small fix extensions workflow tests

* fix annotation in migration script
2024-11-28 16:05:05 +00:00
..
blog chore: fix linter issues 2023-05-04 13:01:15 +02:00
docs Small fixes for docs and extensions workflow tests (#12704) 2024-11-28 16:05:05 +00:00
extensions_versioned_docs/version-v2 migrate docusaurus to v3 and add search for documentation (#12681) 2024-11-28 11:44:56 +00:00
extensions_versioned_sidebars Extensions docs update (#12491) 2024-11-07 09:53:31 +00:00
src Extensions docs update (#12491) 2024-11-07 09:53:31 +00: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 migrate docusaurus to v3 and add search for documentation (#12681) 2024-11-28 11:44:56 +00:00
extensionSidebar.js Extensions docs update (#12491) 2024-11-07 09:53:31 +00:00
extensions_versions.json Extensions docs update (#12491) 2024-11-07 09:53:31 +00:00
internalSidebar.js Refactor extensions docs to enable versioning (#12355) 2024-11-04 16:26:59 +00:00
package.json migrate docusaurus to v3 and add search for documentation (#12681) 2024-11-28 11:44:56 +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.