Skip to content

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

Closed
@Gerrit0

Description

@Gerrit0

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions