mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 12:40:35 +00:00
40c0c9c20f
* first test * remove old reference * bring this file back * generate sidebar and write empty mds * generate index.mdx * get description from cmd_lib * fix reference card error * rename file * generate markdown * regen * add last+hist * update pages with seo metadata * format types * small fix * css sux * add usage placeholder * set hidden by default * nah * add cmds and menus to reference * lint * fix/Users/diogosousa/opt/anaconda3/envs/platform/bin/python /Users/diogosousa/OpenBB/OpenBBTerminal/website/generate_excel_markdown.py * format mds * remove space * fix commands heading * redo folder structure * add back cmd description * move card to var * different main folder * clean * move vars * refer to editor * rename var * done * recreate folder structure * add section: syntax + minor adjustments * remove return type * remove return type * rename api to library * minor fix * remove api folder * remove api folder * formatting * improve basics * basics * fetch functions.json from website * complete basic * change syntax to use semi-colon * basics * basics * remove space in sig * remove sections * add metadata * Update formula builder * add tabs * Update index.md * complete basics and formula_builder * Update index.md * add windows screenshots * restructure folders * regenerate with latest add-in version * move Excel sidebar * rename function and add comment * now it's working * logic * rename folder * Update formula_builder.md * fix * hide excel for now * some explicit typing --------- Co-authored-by: tehcoderer <me@tehcoderer.com>
93 lines
2.1 KiB
JavaScript
Vendored
93 lines
2.1 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} */
|
|
const sidebars = {
|
|
// 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 Excel Add-in",
|
|
items: [{ type: "autogenerated", dirName: "excel" }],
|
|
customProps: {
|
|
hiddenByDefault: true,
|
|
onlyDirectAccess: true,
|
|
},
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "OpenBB Platform",
|
|
items: [
|
|
{ type: "autogenerated", dirName: "platform" }],
|
|
},
|
|
{
|
|
type: "category",
|
|
label: "OpenBB Terminal",
|
|
items: [{ type: "autogenerated", dirName: "terminal" }],
|
|
},
|
|
{
|
|
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 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'],
|
|
},
|
|
],
|
|
*/
|
|
};
|
|
|
|
module.exports = sidebars;
|