search

milesj / docusaurus-plugin-typedoc-api

Docusaurus plugin that provides source code API documentation powered by TypeDoc.
69 stars 25 forks source link

Allow defining order/priorities of ordering for the list of packages #58

Closed B4nan closed 2 years ago

B4nan commented 2 years ago

Currently the packages are ordered alphabetically, which often results in not so good UX, as often the very first package will be some small CLI package that is not really important in terms of API docs. I would like to have some control over this, especially for the sidebar, but ideally it should affect the list of packages (https://crawlee.dev/api) too.

B4nan commented 2 years ago

Maybe it would be enough if there is a callback I could use to adjust the generated sidebar.

milesj commented 2 years ago

I'll look into this as part of the official Docusaurus 2.0 release.

milesj commented 2 years ago

Will be available in the next version as a sortPackages option, which accepts a function.

B4nan commented 2 years ago

Thanks for implementing this. Apparently there is one gotcha - changing the order can result in differences in how typedoc sees the references. I understand it is more of a bug of typedoc, but would it be possible to apply the sorting only on the sidebar items? Because I am affraid it will take ages to land a fix to typedoc for this :/

Just to add more clarity, if I move the @crawlee/basic package under the cheerio one, all symbols it exports will be defined in cheerio package instead, and the basic package will hold only references/re-exports (which is obviously wrong and it also breaks the links as they contain package name). The cheerio package reexports the basic one, its not the other way around.

edit: actually, looking at the code I guess it already works like that and I just changed the order of packages myself (edit2: yop, my bad, you can ignore this)