Skip to content

Port docs to Astro Starlight - #68

Draft
yellowsink wants to merge 3 commits into
mainfrom
starlight
Draft

Port docs to Astro Starlight#68
yellowsink wants to merge 3 commits into
mainfrom
starlight

Conversation

@yellowsink

@yellowsink yellowsink commented Apr 16, 2026

Copy link
Copy Markdown
Member

Vitepress is a lovely docs framework most of the time, but with the addition of shelter UI demos, we've started hitting some realllllly ugly parts of it. Those demos work flawlessly on this branch.

This PR ports the docs over to Astro's Starlight docs framework, which is a very comparable system, but as it is built on Astro makes embedding the solid demos really rather easy.

TODOs:

  • Apply our own brand styling to starlight
  • Fix plugin styles
  • Consider changing the layout or look & feel more drastically than just matching what we did to vp already
  • Check over all internal links - the way headers with .s in gets converted to #s is different between vp and sl

Note we lose out on line numbers in the first plugin guide :<

So be it.

@yellowsink

yellowsink commented Apr 16, 2026

Copy link
Copy Markdown
Member Author

This also opens the door to move remaining docs code (so, the plugin listing FE) away from Vue.

I'm not bothered about doing that personally, but given how heavily shelter is invested into Solid.js, it is nice to have the option.

@taskylizard

taskylizard commented Apr 17, 2026

Copy link
Copy Markdown
Member

Switch, SwitchItem, Checkbox, CheckboxItem, Slider (slider track isn't updating), Modal, genId, ErrorBoundary - do not seem to currently work.

use:tooltip on dev also breaks for some reason? openConfirmationModal on dev is immediately cancelled.

@yellowsink

Copy link
Copy Markdown
Member Author

modals don't work on dev, this is a shui issue not a docs issue, but we should fix it, yes.

@yellowsink
yellowsink force-pushed the main branch 2 times, most recently from 0518459 to c45695b Compare May 7, 2026 11:10
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.

2 participants