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.

Sign up for GitHub

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

The readmeFile param monorepo config is not considered when the .md file is generated #383

Closed
maz-e opened this issue Jan 10, 2023 · 2 comments
Closed

The readmeFile param monorepo config is not considered when the .md file is generated #383

maz-e opened this issue Jan 10, 2023 · 2 comments
Labels
next Fix available in the '@next' release

Comments

@maz-e
Copy link

maz-e commented Jan 10, 2023

As it says in https://typedoc.org/guides/monorepo/#typedoc-package-config, the README file set in the readmeFile config should be displayed on the index page of the package doc. Still, when the plugin generates the package/module .md file, only the classes, types or interfaces are displayed, and the README file is removed from the content.
This was referenced Jan 23, 2023
Closed
Merged
@tgreyuk
Copy link
Member

tgreyuk commented Jan 29, 2023 •
edited
Loading

This had been fixed, but only in the next version. (typedoc-plugin-markdown@next).

@tgreyuk tgreyuk added the next Fix available in the '@next' release label Jan 29, 2023
This was referenced Apr 4, 2024
Open
Closed
@tgreyuk
Copy link
Member

tgreyuk commented May 3, 2024

typedoc-plugin-markdown@4.0.0

@tgreyuk tgreyuk closed this as completed May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
next Fix available in the '@next' release
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@maz-e @tgreyuk