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

tsdoc custom tags supporting #5

Closed
kazupon opened this issue Jul 1, 2020 · 2 comments · Fixed by #31
Closed

tsdoc custom tags supporting #5

kazupon opened this issue Jul 1, 2020 · 2 comments · Fixed by #31
Labels
Type: Feature Includes new features

Comments

@kazupon
Copy link
Owner

kazupon commented Jul 1, 2020

No description provided.

@kazupon kazupon added the Type: Feature Includes new features label Jul 1, 2020
@kazupon kazupon changed the title tsdoc custom tags supporing tsdoc custom tags supporting Jul 2, 2020
@kazupon
Copy link
Owner Author

kazupon commented Nov 23, 2020 •
edited
Loading

We prefer to respond with official support by the api-extractor, preferably in the following PR and so on.
microsoft/rushstack#1628

However, since it is not yet supported, it is addressed below.

  • Use the custom tag defined in tsdoc.config and read it with the --tsdocConfig CLI option
  • Inject custom tag definitions into the AedocDefinitions.tsdocConfiguration.

@kazupon
Copy link
Owner Author

kazupon commented Nov 23, 2020

This is the adoc temporary resolving.
When official support is added, support for custom tags via the --tsdocConfg CLI option will be deprecated.

@kazupon kazupon mentioned this issue Nov 23, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: Feature Includes new features
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: support custom tags kazupon/api-docs-gen
1 participant
@kazupon