typedoc2md/typedoc-plugin-markdown

Is it possible to change the name of a category in the typedoc-sidebar.cjs?

Closed this issue · 1 comments

What package is your question related to?

docusaurus-plugin-typedoc

What would you like to ask?

Hi,

is it possible to change the name of a category in the typedoc-sidebar.cjs?

I have the following typedoc-sidebar.cjs:

const typedocSidebar = { items: [
  {
    "type": "category",
    "label": "SDK/C.S.SDK.ADO",
    "items": [
      {
        "type": "category",
        "label": "Classes",
        "items": [
          {
            "type": "doc",
            "id": "api/SDK/C.S.SDK.ADO/classes/ADOConnectionBuilder",
            "label": "ADOConnectionBuilder"
          }
          ]
      }
    ]
    }
  ]
};

What i would like to get:

const typedocSidebar = { items: [
  {
    "type": "category",
    "label": "C.S.SDK.ADO", /*<-- Remove the SDK here*/
    "items": [
      {
        "type": "category",
        "label": "Classes",
        "items": [
          {
            "type": "doc",
            "id": "api/SDK/C.S.SDK.ADO/classes/ADOConnectionBuilder",
            "label": "ADOConnectionBuilder"
          }
          ]
      }
    ]
    }
  ]
};

With kind ringars,
David

@DavidBal the top level category label is essentially the resolved typedoc module name that contains the exported symbols. You can control this with the @module tag - see https://typedoc.org/tags/module/.