Skip to content

[Feature]: Allow anchors in @page #257

@dzek69

Description

@dzek69

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?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions