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

How to load Readme.md after update (includes removed) #2642

Closed
goyertp opened this issue Jul 17, 2024 · 2 comments
Closed

How to load Readme.md after update (includes removed) #2642

goyertp opened this issue Jul 17, 2024 · 2 comments
Labels
question Question about functionality

Comments

@goyertp
Copy link

goyertp commented Jul 17, 2024

Hey,

In the last change, you removed the --includes option, suggesting the use of the @document tag instead. This is unfortunate because maintaining the README.md and later including it with includes was simple and efficient.

Maintaining Markdown in the README.md is easy, straightforward, and a standard in many companies.

We loaded it like this:

/** @packageDocumentation
 * [[include:aws-ses/README.md]]
 */
export * from "./ses-smtp-user";

The content of the file was directly viewable within the class/module and not on a separate page.
Can you somehow make this possible again?

Regards

Philipp

@goyertp goyertp added the question Question about functionality label Jul 17, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 18, 2024

I have no plans to include this in typedoc itself. It is easy to write a custom plugin which does this, see microsoft/tsdoc#22 (comment)

@goyertp goyertp closed this as completed Jul 18, 2024
@goyertp
Copy link
Author

goyertp commented Jul 18, 2024

Thanks for your feedback.

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

No branches or pull requests

2 participants