Skip to content

Fix/doc links #37

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.

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix/doc links #37

wants to merge 4 commits into from

Conversation

Romulad
Copy link

@Romulad Romulad commented May 9, 2025

What:

  • Fixed .md links in the docs/ folder by appending the .md extension to avoid 404 errors when browsing on GitHub.
  • Added a custom rehype plugin to the Astro site under website/ to remove .md extensions from built links on the live documentation site, keeping the URLs clean while preserving functionality.

Why:

  • Similar to what was reported in PR docs: fix docs link, improve liking #32: navigating through the GitHub docs leads to broken links (e.g., introduction.md pointing to other docs without .md and returning 404s).
  • To prevent the website build from breaking, the rehype plugin strips .md only during the static site generation, so both GitHub and the live site remain functional and consistent.

How:

  • Manually updated internal links in Markdown files within the docs/ directory.
  • Created a simple rehype plugin in website/ that removes the .md extension from links during the Astro build phase, while keeping original links in the source untouched.

Checklist:

  • Tests " N/A"
  • TypeScript definitions updated "N/A"
  • Ready to be merged

Note:
I discovered this project while working on a CLI app and also came across your work—which I truly admire. I'm currently reading your book The Framework Field Guide – Fundamentals (on Chapter 5!), and I'm really excited about what's coming next with the Ecosystem and Internals. Thanks for all the value you're putting into the community.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant