Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TypeDoc should check for the README file adjacent to the package.json for a project #2875

Closed
Gerrit0 opened this issue Feb 26, 2025 · 2 comments
Milestone

Comments

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Feb 26, 2025

Discussed in #2873

Originally posted by kaiyoma February 25, 2025
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?

@Gerrit0 Gerrit0 added this to the v0.28.0 milestone Feb 26, 2025
Gerrit0 added a commit that referenced this issue Feb 27, 2025
@Gerrit0 Gerrit0 closed this as completed Feb 27, 2025
@kaiyoma
Copy link

kaiyoma commented Mar 13, 2025

@Gerrit0 When can we expect a release that has this fix?

@Gerrit0
Copy link
Collaborator Author

Gerrit0 commented Mar 14, 2025

TypeDoc 0.28 is now in beta! 🎉
The full release is planned for 2025-03-14.

#2868

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants