Navigation Menu

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

Jump to bottom

Show README of packages in monorepo #1658

Closed
AllanZhengYP opened this issue Aug 16, 2021 · 2 comments · Fixed by #1977
Closed

Show README of packages in monorepo #1658

AllanZhengYP opened this issue Aug 16, 2021 · 2 comments · Fixed by #1977
Labels
enhancement Improved functionality
Projects
Guides (#247) - v0.24

Comments

@AllanZhengYP
Copy link

Search terms

monorepo, readme, workspace

Question

I'm migrating a monorepo using typedoc@0.19, and I found README file under each subpackage is missing. The command I'm using is typedoc --packages 'a' --packages 'b'. Did I miss any config?

My WIP branch: https://github.com/AllanZhengYP/aws-sdk-js-v3/tree/typedoc/0.20
@AllanZhengYP AllanZhengYP added the question Question about functionality label Aug 16, 2021
@Gerrit0 Gerrit0 added enhancement Improved functionality and removed question Question about functionality labels Aug 16, 2021
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Aug 16, 2021

TypeDoc today doesn't include readme files from each package in a monorepo setup, nope, you didn't miss anything

@Gerrit0 Gerrit0 added this to To do in Guides (#247) - v0.24 via automation Sep 6, 2021
@Gerrit0 Gerrit0 mentioned this issue Nov 10, 2021
Closed
@mokone91
Copy link

It would be nice to have this feature

@akphi akphi mentioned this issue Jul 2, 2022
Merged
2 tasks
Guides (#247) - v0.24 automation moved this from To do to Done Jul 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Improved functionality
Projects
No open projects
Guides (#247) - v0.24
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve support for --entryPointStrategy Packages akphi/typedoc
3 participants
@mokone91 @AllanZhengYP @Gerrit0