Replies: 1 comment 3 replies
-
Currently, there isn't a way to do that, however I think it's a good idea for TypeDoc to behave in that way. It should search for the package.json for documentation, then once that's discovered, check next to it for the readme. I've created #2875 to track making that change to TypeDoc |
Beta Was this translation helpful? Give feedback.
3 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
We have a large monorepo with hundreds of packages and we'd like to start generating docs for them. Some packages have a README, some do not. For the packages that don't have a README, typedoc is searching up the tree for one, finding our README in the root of the repo, and then including that in the package docs (which obviously we don't want). I don't want to set
--readme none
because that will penalize the packages that do have a README. Is there a way to tell typedoc to limit its search to the local package only?Beta Was this translation helpful? Give feedback.
All reactions