dashboard/docusaurus
Evgeniya Vashkevich e1e173cf95
Fixed docusaurus failing (#14405)
2025-05-27 23:06:21 -07:00
..
blog chore: fix linter issues 2023-05-04 13:01:15 +02:00
docs Add internal api scaffolding and documentation (#13839) 2025-04-14 13:11:47 -04:00
extensions/catalog add vcloud director node driver to community catalog (#13973) 2025-04-02 18:08:34 +01:00
extensions_versioned_docs/version-v2 remove documentation about catalog.cattle.io/ui-version as its a pattern we should not encourage (#13873) 2025-03-26 09:31:55 +00:00
extensions_versioned_sidebars Extension creator upgrade paths - Update documentation (#12737) 2024-12-02 13:26:24 -05:00
plugins/catalog Fix responsiveness for small screens for catalog docs page (#14040) 2025-04-07 15:31:38 +01: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 Add extension catalog page and initial contents (#13769) 2025-03-20 09:15:54 +00:00
extensionSidebar.js Add extension catalog page and initial contents (#13769) 2025-03-20 09:15:54 +00:00
extensions_versions.json Extensions docs update (#12491) 2024-11-07 09:53:31 +00:00
internalSidebar.js Add internal api scaffolding and documentation (#13839) 2025-04-14 13:11:47 -04:00
package.json Fixed docusaurus failing (#14405) 2025-05-27 23:06:21 -07: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.