We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
anchor, examples, ids, headers
There is no possibility to give a link to a header from generated documentation. I would like to link examples in readme
Add ids to headers like you do in your own documentation: https://typedoc.org/guides/doccomments/#escaping-comments
The text was updated successfully, but these errors were encountered:
Typedoc already does this?
https://typedoc.org/example/#md:index-of-examples
Sorry, something went wrong.
Typedoc already does this? https://typedoc.org/example/#md:index-of-examples
Thank you for answer. I actually just now came to this solution:
/** * @example * #### Example 1 * ... Code * #### Example 2 * ... Code */
Before I have been using @example tag multiple times. Is my solution fine?
@example
Ah, yes, typedoc doesn't put out ids for headings generated from tag names, it totally should though!
No branches or pull requests
Search Terms
anchor, examples, ids, headers
Problem
There is no possibility to give a link to a header from generated documentation.
I would like to link examples in readme
Suggested Solution
Add ids to headers like you do in your own documentation: https://typedoc.org/guides/doccomments/#escaping-comments
The text was updated successfully, but these errors were encountered: