search

milesj / docusaurus-plugin-typedoc-api

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

Disable API in versioned docs #146

Open fgatti675 opened 1 month ago

fgatti675 commented 1 month ago

Hi, me again :) My docusaurus project has 3 versions, and I only want to generate the API for the latest one. I would like to leave older versions as they are. If I don't add versioned APIs, I get the error:

[cause]: Error: ENOENT: no such file or directory, open '/website/versioned_docs/version-2.0.0/api-packages.json'

If I generate that file with yarn docusaurus api:version 2.0.0 I get an error for each different API item:

 Error: Can't render static file for pathname "/docs/api/next/function/getValueInPath"

(note that is using next instead of 2.0.0 which is the version name, there are no references to next anywhere in my codebase)

I don't need the API in older versions and would rather have it disabled. Is it possible? Thanks!

fgatti675 commented 1 month ago

Alternative, I have been trying to simply create a placeholder of the config json files to make the plugin happy, but no luck. Would you have some examples by any chance? Thanks!

milesj commented 1 month ago

This plugin piggy-backs off docusaurus's official versioning system, so we don't really have much control over it.

However, docusuaurus supports a few options that the plugin inherits, that maybe can work here? They are disableVersioning, onlyIncludeVersions, lastVersion, and a few others.