Skip to content

Add clickable section links in documentation similar to that in README.md #322

Open
@Andrew15-5

Description

@Andrew15-5

The problem with current documentation is that I constantly have to "right-click on the section" + Q (Firefox), copy id of the section element in the DOM, paste it in the current address bar and then copy the whole URL to the section.

I have to do this every time and it becomes tedious. I would like to have a similar UX to the one of README.md:

image

image

When I press the link, it forwards me to the same page, but with the id of the Installation section appended (#installation)). I can then press yy (Vimium C extension) to copy it. Very fast and no hustle.

Documentation sections are now just plain text with no interactiveness:

image

https://typst.app/docs/reference/syntax/#math

However, it would be even better, if I can (again) click the "section name" and it will append its id to the URL in the address bar, but also if I click on the "link"/"copy" icon next to the section it would just copy the URL to this section into the clipboard.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsImprovements or additions to documentation UX.feature requestNew feature or request.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions