Sidebar Configuration in sidebars.js file

[inhwaS]

What package is your question related to?

typedoc-plugin-markdown

What would you like to ask?

Hello, I would like to ask another question in extenstion for #705 .
Based on this change log, it is guided to do:

Does it mean that I should not use like code like:
https://github.com/facebook/lexical/blob/e96ee55b749c0fed8ac03d49044dd5594f0bc32e/packages/lexical-website/sidebars.js#L23-L25

Since it automatically creates so many files, I’m concerned that I will need to document all the markdown files, as the autogenerated process creates roughly 50 files in total. Can I ask how people typically handle updates?

[tgreyuk]

Hi @inhwaS,

Rather than reference type: "autogenerated" you would reference the auto generated sidebar.

So you would replace:

  api: [{dirName: 'api', type: 'autogenerated'}],

with (you might need to tweak the path but this is the general idea):

api: [{
      type: 'category',
      label: 'api',
      link: {
        type: 'doc',
        id: 'api/index',
      },
      items: require('./docs/api/typedoc-sidebar.cjs'),
    }],

So you wouldn't need to worry about managing the files - the autogenerated sidebar will do that.

Hope this makes sense.

Let me know how you get on.