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

[Feature]: Allow anchors in @page #257

Open
dzek69 opened this issue Nov 11, 2022 · 2 comments
Open

[Feature]: Allow anchors in @page #257

dzek69 opened this issue Nov 11, 2022 · 2 comments
Labels

Comments

@dzek69
Copy link

dzek69 commented Nov 11, 2022

Plugin

@knodes/typedoc-plugin-pages

What would you want ?

I want to link to a specific part of the page. Each header in markdown creates an anchor, so I can send a link to a friend to a given section of a page, like:
http://127.0.0.1:8082/pages/tutorials/03events.html#task_add

now I want to link to this specific part of the page from a {@page} link, i tried using {@page 02advanced.md#Something-something Title} but it doesn't work.

Something like that would be appreciated. I know hash is a valid character for a filename - there are few approaches to that:

  • first try full file name, if not found look for hash - if found use the left part as a file name - if it's valid then create a link to the page and append the hash part
  • Add a optional hash parameter between the file path and title. This will prevent possibility of the title from starting with hash however, but maybe an escaping can be added here if really needed.
  • something else, that will be breaking change in one-in-the-million case only?
@dzek69 dzek69 added enhancement New feature or request triage labels Nov 11, 2022
@GerkinDev
Copy link
Member

Hi, this is a nice feature request, and not really complicated to implement in the most naive way. You can expect it in one of the next releases (which may take some time though, kinda busy currently)

@rasmus-kirk
Copy link

Any updates on this?

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

No branches or pull requests

3 participants