Skip to content

docs: add rehype-gfm-components plugin#3711

Open
claylo wants to merge 1 commit intowithastro:mainfrom
claylo:docs/add-rehype-gfm-components
Open

docs: add rehype-gfm-components plugin#3711
claylo wants to merge 1 commit intowithastro:mainfrom
claylo:docs/add-rehype-gfm-components

Conversation

@claylo
Copy link

@claylo claylo commented Feb 15, 2026

Write GFM, view it on GitHub, deploy it with Starlight. The same Markdown file for both -- all content easily viewable on GitHub, still transforms to rich and interactive components on your Starlight site. No MDX, no imports.

Description

Just a plugin for those who want to use Starlight ... and also want their docs to be fully readable on GitHub. (It can't be just me, right?)

Thank you for all your efforts on Starlight! I'm loving it.

Write GFM, view it on GitHub, deploy it with Starlight. The same Markdown file for both -- all content easily viewable on GitHub, still transforms to rich and interactive components on your Starlight site. No MDX, no imports.
@changeset-bot
Copy link

changeset-bot bot commented Feb 15, 2026

⚠️ No Changeset found

Latest commit: 5821041

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@netlify
Copy link

netlify bot commented Feb 15, 2026

Deploy Preview for astro-starlight ready!

Name Link
🔨 Latest commit 5821041
🔍 Latest deploy log https://app.netlify.com/projects/astro-starlight/deploys/69910feb1683bb0008058b9f
😎 Deploy Preview https://deploy-preview-3711--astro-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions bot added the 📚 docs Documentation website changes label Feb 15, 2026
@astrobot-houston
Copy link
Contributor

Hello! Thank you for opening your first PR to Starlight! ✨

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any issues you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🤩

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

@astrobot-houston
Copy link
Contributor

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en resources/plugins.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR and plugin @claylo!

One note: looks like this provides a Starlight plugin, so I think it would make sense to move this up to the “Community plugins” section (rather than the tools and integrations section where it is now).

Also, if you’ll permit me a pinch of feedback, it looks like there’s something up with the file tree in your example site? Maybe some styles that aren’t quite right? And the .astro icons are missing.

file tree without spacing between icons and file names

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

Labels

📚 docs Documentation website changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants