Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add the @HiDeoo/starlight-github-alerts extension to the docs so that it renders github alerts properly.
Add starlight-github-alerts extension for proper GitHub alert rendering in docs
Sep 12, 2025
This file contains hidden or 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
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.
This PR adds the
starlight-github-alertsextension to the documentation site to properly render GitHub-style alerts as styled Starlight aside components.Problem
Previously, GitHub-style alerts like
> [!TIP]and> [!CAUTION]were being rendered as plain blockquotes in the documentation, losing their visual impact and semantic meaning. For example:This would render as a plain blockquote without any special styling or indication that it was meant to be a tip.
Solution
Added the
starlight-github-alertsnpm package and configured it in the Astro/Starlight setup:starlight-github-alertsas a dev dependencydocs/astro.config.mjsto include the plugin in the Starlight plugins arrayChanges Made
starlight-github-alertsdependencyVisual Impact
The alerts now render with:
[!TIP],[!CAUTION],[!NOTE],[!IMPORTANT],[!WARNING]Before: Plain blockquote text without styling
After: Styled alert boxes with icons that match GitHub's visual style
The alerts now seamlessly integrate with the Starlight theme while maintaining the familiar GitHub alert styling that users expect.
Testing
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
api.contoso.com/tmp/go-build2740652177/b278/cli.test -test.testlogfile=/tmp/go-build2740652177/b278/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true(dns block)/tmp/go-build1960199199/b278/cli.test -test.testlogfile=/tmp/go-build1960199199/b278/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true(dns block)telemetry.astro.buildnode /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build(dns block)node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro dev --port 3000 --host 0.0.0.0(dns block)If you need me to access, download, or install something from one of these locations, you can either:
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.