-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Add documentation on making dev overlay plugins #5183
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great @Princesseuh ! I almost feel like I could write a plugin... 😄
Left some suggestions, and I do think changing the main filename to dev-overlay-plugin-reference.mdx
makes a lot of sense, since this really is geared towards writing plugins specifically.
See what you think about some of my suggestions below, and of course, change whatever is necessary!
Co-authored-by: Sarah Rainsberger <[email protected]>
@Princesseuh This all looks amazing! I'm going to just re-visit that one |
Hmm, that would definitely be nice, but I'm not sure how. Probably that the docs repo could take the icon's codes directly from the main repo and use them that way. Since it's still very possible for that file to move around and be changed fairly consequentially, I prefer doing it in a separate effort once the refactors are done! |
Co-authored-by: Sarah Rainsberger <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ready for minor release! 🥳
The file `nav.ts` has been updated to align with the English language documentation based on this commits withastro#4876 , withastro#5183 , withastro#5213 , withastro#5271 , withastro#5187 , withastro#4667 , withastro#5541 , withastro#5605 , withastro#5499 , withastro#6470 , withastro#6620
Description (required)
Docs for withastro/astro#8757.
Since the dev overlay API is very early still, the content is a bit light. But, this should provide a basic guide over the different hooks and features that should still be appreciated by the few people who will make dev overlay plugins already.
This is intentionally only in the references while the dev overlay is so early and very much lacking in features. In a very close future, I'll be sending a PR to add more references to it throughout the docs where relevant. (Right now, we don't mind too much people not using it, so no big marketing needed until it's very cool!)