New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use relative file paths (with .md extensions) instead of relative URL links #63

Open

skyfrk opened this issue Jun 28, 2022 · 0 comments

Labels

enhancement good first issue

Member

skyfrk commented Jun 28, 2022

See https://docusaurus.io/docs/markdown-features/links

Using relative file paths (with .md extensions) instead of relative URL links provides the following benefits:

Links will keep working on the GitHub interface and many Markdown editors
You can customize the files' slugs without having to update all the links
Moving files around the folders can be tracked by your editor, and some editors may automatically update file links
A versioned doc will link to another doc of the exact same version
Relative URL links are very likely to break if you update the trailingSlash config

skyfrk added enhancement good first issue labels

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