qmk_firmware icon indicating copy to clipboard operation
qmk_firmware copied to clipboard

Links in GitHub `docs/` broken?

Open tzarc opened this issue 1 year ago • 0 comments

Actually, they're not -- 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.

tzarc avatar Jul 18 '24 22:07 tzarc