Skip to content

Links in GitHub docs/ broken? #24151

Open
@tzarc

Description

If you've been linked this issue on one of your PRs, thanks for putting in the effort to raise it, but it's incorrect. GitHub isn't the intended viewer for QMK's documentation.

QMK Firmware uses VitePress for publishing docs to the QMK Firmware docs website.
Best practices for VitePress does not include the trailing .md in links, and QMK follows these best practices.

If you wish to view your local copy of the docs -- handy when you're making a PR -- make sure you have yarn installed and run qmk docs.

Issues and PRs asking to "fix", or "fixing" the trailing .md will be closed.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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