Files
OpenBB/website/sidebars.js
Henrique Joaquim 8d060dc071 [Feature] CLI docs (#6362)
* cli docs website

* changes

* remove unused feat flags

* typo

* yeet stuff that can't be used

* some progress

* Add home screenshot

* screenshots.md

* fix links

* new cards for cli pages

* start config page

* more updates

* Add screenshots

* flatten some things.

* fix link

* some more updates

* some routine stuff

* codespell

* cli color

* results in the global commands

* increase codeBlock line-height

* remove platform warning, obb is a class

* minor change, danger warning

* typo?

* Data processing commands

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
2024-05-14 15:44:07 +00:00

94 lines
2.2 KiB
JavaScript
Vendored

/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
// @ts-check
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
export default {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [
{
type: "category",
label: "OpenBB Terminal Pro",
items: [{ type: "autogenerated", dirName: "pro" }],
customProps: {
hiddenByDefault: true,
},
},
{
type: "category",
label: "OpenBB Add-in for Excel",
items: [{ type: "autogenerated", dirName: "excel" }],
customProps: {
hiddenByDefault: true,
},
},
{
type: "category",
label: "OpenBB Platform",
items: [{ type: "autogenerated", dirName: "platform" }],
},
{
type: "category",
label: "OpenBB CLI",
items: [{ type: "autogenerated", dirName: "cli" }],
},
{
type: "category",
label: "OpenBB Bot",
items: [{ type: "autogenerated", dirName: "bot" }],
},
{
type: "html",
value: '<span class="sidebar-divider" />',
},
{
type: "html",
className: "sidebar-title",
value: "LEGACY",
defaultStyle: true,
},
{
type: "category",
label: "OpenBB Terminal",
items: [{ type: "autogenerated", dirName: "terminal" }],
},
{
type: "category",
label: "OpenBB SDK",
items: [{ type: "autogenerated", dirName: "sdk" }],
},
// Can do stuff like this too
// {
// type: "html",
// defaultStyle: true,
// className: "powered-by-banner",
// value: `
// <span>Powered by</span>
// <img src="/img/docusaurus.png" alt="Docusaurus Logo" />
// `,
// },
],
// But you can create a sidebar manually
/*
tutorialSidebar: [
'intro',
'hello',
{
type: 'category',
label: 'Tutorial',
items: ['tutorial-basics/create-a-document'],
},
],
*/
};