search

milesj / docusaurus-plugin-typedoc-api

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

[Question] Is there a way to modify the route slugs? #144

Open littlespex opened 2 months ago

littlespex commented 2 months ago

We have migrated from docusaurus-plugin-typedoc and are very happy with the results. Unfortunately the URLs to our API members have now changed, and this would break persistent links in the wild. Is there a way to modify/configure the route slugs that are generated?

milesj commented 2 months ago

@littlespex What's the difference exactly?

littlespex commented 2 months ago

docusaurus-plugin-typedoc allowed the output folder to be configured, which we setup as:

`/apis/${unscopedPackageName}/interface/PlayerInterface`

docusaurus-plugin-typedoc-api uses the package's folder name from the mono-repo, and api instead of apis:

`/api/${folderName}/interface/PlayerInterface`
milesj commented 2 months ago

I'm open to a setting for this, I just don't have the time myself to look into it.