Skip to content

Generate docs for README-only package #2264

@cprussin

Description

@cprussin

Search terms

readme, packages

Question

I have one package in my monorepo that just exports shared tsconfig.json files. As such, that package doesn't have any entry points for typedoc to use. However, I'd still like that package included in my documentation, with just the README rendered in the package's section of the docs (or maybe with the contents of the json files if possible). It seems like right now, typedoc bails on any package that doesn't have entry points, but is there a way to tell typedoc to generate a README-only doc site (or include the json contents possibly)?

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueEasier issue for first time contributors

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions