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

Add ids to tag-generated headers #2308

Closed
FreePhoenix888 opened this issue Jun 9, 2023 · 5 comments
Closed

Add ids to tag-generated headers #2308

FreePhoenix888 opened this issue Jun 9, 2023 · 5 comments
Labels
enhancement Improved functionality
Milestone

Comments

@FreePhoenix888
Copy link

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

@FreePhoenix888 FreePhoenix888 added the enhancement Improved functionality label Jun 9, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 9, 2023

Typedoc already does this?

https://typedoc.org/example/#md:index-of-examples

@FreePhoenix888
Copy link
Author

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?

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 11, 2023

Ah, yes, typedoc doesn't put out ids for headings generated from tag names, it totally should though!

@Gerrit0 Gerrit0 changed the title Add ids to headers Add ids to tag-generated headers Aug 28, 2023
@Gerrit0 Gerrit0 added this to the v0.26.0 milestone Oct 15, 2023
Gerrit0 added a commit that referenced this issue Jun 12, 2024
@Gerrit0 Gerrit0 modified the milestones: v0.27.0, v0.26.0 Jun 12, 2024
@Gerrit0 Gerrit0 mentioned this issue Jun 16, 2024
7 tasks
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 16, 2024

Fixed with 0.26, which is releasing 2024/06/21

@Gerrit0 Gerrit0 closed this as completed Jun 16, 2024
@FreePhoenix888
Copy link
Author

Thank you! @Gerrit0

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

No branches or pull requests

2 participants