sidebars.js

/**
 * 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: 'autogenerated', dirName: '.'}],

  // But you can create a sidebar manually
  v3SideBar: [
      'v3/intro',
    {
      type: 'category',
      label: 'Tax',
      items: [
        {
          type: 'autogenerated',
          dirName: 'v3/tax'
        }
      ]
    }
  ],
  v5SideBar: [
    'v5/intro',
    'v5/guide',
    'v5/acct-mode',
    'v5/announcement',
    'v5/smp',
    'v5/copytrade',
    'v5/demo',
    {
      type: 'category',
      label: 'Market',
      items: [
        {
          type: 'autogenerated',
          dirName: 'v5/market'
        }
      ]
    },
    {
      type: 'category',
      label: 'Trade',
      items: [
        {
          type: 'autogenerated',
          dirName: 'v5/order'
        }
      ]
    },
    {
      type: 'category',
      label: 'Position',
      items: [
        {
          type: 'autogenerated',
          dirName: 'v5/position'
        }
      ]
    },
    {
      type: 'category',
      label: 'Pre-upgrade',
      items: [
        {
          type: 'autogenerated',
          dirName: 'v5/pre-upgrade'
        }
      ]
    },
    {
      type: 'category',
      label: 'Account',
      items: [
        {
          type: 'autogenerated',
          dirName: 'v5/account'
        }
      ]
    },
    {
      type: 'category',
      label: 'Asset',
      items: [
        'v5/asset/delivery',
        'v5/asset/settlement',
        'v5/asset/exchange',
        'v5/asset/coin-info',
        'v5/asset/sub-uid-list',
        {
          type: 'category',
          label: 'Balances',
          items: [
            {
            type: 'autogenerated',
            dirName: 'v5/asset/balance'
            }
          ]
        },
        {
          type: 'category',
          label: 'Transfer',
          items: [
            {
            type: 'autogenerated',
            dirName: 'v5/asset/transfer'
            }
          ]
        },
        {
          type: 'category',
          label: 'Deposit',
          items: [
            {
            type: 'autogenerated',
            dirName: 'v5/asset/deposit'
            }
          ]
        },
        {
          type: 'category',
          label: 'Withdraw',
          items: [
            {
            type: 'autogenerated',
            dirName: 'v5/asset/withdraw'
            }
          ]
        },
        {
          type: 'category',
          label: 'Convert',
          items: [
            {
            type: 'autogenerated',
            dirName: 'v5/asset/convert'
            }
          ]
        }
      ]
    },
    {
      type: 'category',
      label: 'User',
      items: [
        {
          type: 'autogenerated',
          dirName: 'v5/user'
        }
      ]
    },
    {
      type: 'category',
      label: 'Affiliate',
      items: [
        {
          type: 'autogenerated',
          dirName: 'v5/affiliate'
        }
      ]
    },
    {
      type: 'category',
      label: 'Spot Leverage Token',
      items: [
        {
          type: 'autogenerated',
          dirName: 'v5/lt'
        }
      ]
    },
    {
      type: 'category',
      label: 'Spot Margin Trade (UTA)',
      items: [
        {
          type: 'autogenerated',
          dirName: 'v5/spot-margin-uta'
        }
      ]
    },
    {
      type: 'category',
      label: 'Crypto Loan',
      items: [
        {
          type: 'autogenerated',
          dirName: 'v5/crypto-loan'
        }
      ]
    },
    {
      type: 'category',
      label: 'Institutional Loan',
      items: [
        {
          type: 'autogenerated',
          dirName: 'v5/otc'
        }
      ]
    },
    {
      type: 'category',
      label: 'Exchange Broker',
      items: [
        'v5/broker/exchange-earning',
        'v5/broker/account-info',
        'v5/broker/sub-deposit-record',
        {
          type: 'category',
          label: 'Reward',
          items: [
            {
            type: 'autogenerated',
            dirName: 'v5/broker/reward'
            }
          ]
        }
      ]
    },
    {
      type: 'category',
      label: 'WebSocket Stream',
      items: [
          'v5/websocket/wss-authentication',
        {
          type: 'category',
          label: 'Public',
          items: [
            {
              type: 'autogenerated',
              dirName: 'v5/websocket/public'
            }
          ]
        },
        {
          type: 'category',
          label: 'Private',
          items: [
            {
              type: 'autogenerated',
              dirName: 'v5/websocket/private'
            }
          ]
        },
        {
          type: 'category',
          label: 'Trade',
          items: [
            {
              type: 'autogenerated',
              dirName: 'v5/websocket/trade'
            }
          ]
        }
      ]
    },
    'v5/rate-limit',
    'v5/enum',
    'v5/error',
    {
      type: 'category',
      label: 'Abandoned Endpoints',
      items: [
        {
          type: 'autogenerated',
          dirName: 'v5/abandon'
        }
      ]
    },
  ],
  apiExplorerSideBar: [
    {
      type: "category",
      label: "V5",
      link: {
        type: "generated-index",
        title: "V5 API",
        slug: "/api-explorer/v5/category/"
      },
      // @ts-ignore
      items: [
        require("./docs/api-explorer/v5/market/sidebar.js"),
        require("./docs/api-explorer/v5/trade/sidebar.js"),
        require("./docs/api-explorer/v5/position/sidebar.js"),
        require("./docs/api-explorer/v5/account/sidebar.js"),
        require("./docs/api-explorer/v5/asset/sidebar.js"),
        require("./docs/api-explorer/v5/user/sidebar.js"),
        require("./docs/api-explorer/v5/lt/sidebar.js"),
        require("./docs/api-explorer/v5/spot-margin-uta/sidebar.js"),
        require("./docs/api-explorer/v5/spot-margin-normal/sidebar.js"),
      ]
    }
  ],
  changelogSidebar: [
    "changelog/v5"
  ]
};

module.exports = sidebars;