feat(docs): add Vite Plugin to Remove .md Extensions from URLs #1580
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
❌ Deploy Preview for realworld-docs failed.
|
❌ Deploy Preview for frabjous-strudel-0577e0 failed.
|
- Implement `remove-md-extension` plugin to clean URLs by removing `.md` extensions. - Fix 404 errors caused by `.md` extensions in Markdown links. - Update documentation with usage instructions and examples.
geromegrignon
force-pushed
the
feature/remove-md-extension-plugin
branch
from
f38489b
to
1fa55a5
Compare
|
Thanks fro the contribution @yurisldk |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a custom Vite plugin that removes
.mdfile extensions from URLs during the build process. This fix addresses the common issue of 404 errors due to Markdown links containing.mdextensions.closes #1564
Motivation
In Astro and Vite projects, links to Markdown files often include the
.mdextension. This plugin automatically removes.mdextensions from internal URLs, ensuring clean and functional links like/specifications/backend/api-response-format#users-for-authenticationinstead of/specifications/backend/api-response-format.md#users-for-authentication.Benefits
.mdextensions..md.This plugin ensures that all internal links remain functional and clean, improving both user experience and SEO.
Summary
copilot:summary
Details
copilot:walkthrough