mirror of https://github.com/rancher/dashboard.git
|
|
||
|---|---|---|
| .. | ||
| blog | ||
| docs | ||
| extensions/catalog | ||
| extensions_versioned_docs/version-v2 | ||
| extensions_versioned_sidebars | ||
| plugins/catalog | ||
| src | ||
| static | ||
| .gitignore | ||
| README.md | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| extensionSidebar.js | ||
| extensions_versions.json | ||
| internalSidebar.js | ||
| package.json | ||
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.jsfile to generate a custom sidebar.
-
Create a Markdown file, greeting.md, and place it under the docs directory.
-
Add file name in
sidebars.js.