Skip to content

Anchor links do not match generated VuePress headers #764

@Desiders

Description

@Desiders

Motivation

I noticed that in the docs many places when links don't match "correct" headers, for example:
https://xtls.github.io/ru/config/api.html#api -> См. раздел Связанные настройки в этом документе -> doesn't match header Связанные настройки.

Reason

VuePress replace some characters on build stage, for example й to и in the case above. This behavior described in the issue.

Proposal

Fix the links to use the correct generated link in the header, for example: #связанные-настройки should be #связанные-настроики.
But this change has problems: some links become non-working in the IDE/GitHub because #связанные-настроики don't point to the header Связанные настройки until docs doesn't build.
So there is also a variant to specify header's links before compilation for IDE/GitHub: ## Связанные настройки -> ## <a id="связанные-настроики"></a>Связанные настроики, but it's not a very intuitive option for developers.

Alternatives

A way to off such behavior of the library

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions