Build beautiful, accessible, high-performance documentation websites with Qwik
nobody
1c7216416a
README covers the two main departures from upstream Starlight: framework-agnostic components via Mitosis and multi-folder content mounting. Style guide captures the writing voice we're targeting for user-facing text. |
||
|---|---|---|
| docs | ||
| examples | ||
| packages | ||
| scripts | ||
| upstream@2898bb7a81 | ||
| .gitignore | ||
| .gitmodules | ||
| .yarnrc.yml | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| yarn.lock | ||
Starlight, Universalized
Starlight builds great docs sites, but it only works with Astro. This project breaks that coupling.
All of Starlight's UI components are rebuilt with Mitosis so they compile natively to Qwik, React, Solid, Vue, Angular, and others. The "point a folder of Markdown at a framework and get a docs site" workflow is preserved, with one addition: you can mount multiple content directories at different URL prefixes.
content: merge(
withPrefix('sdk', collection({ directory: 'content/sdk' })),
withPrefix('api', collection({ directory: 'content/api' })),
)
Helpful when you have several products sharing one site.
Examples
- examples/basics -- minimal setup
- examples/kitchen-sink -- full demo
License
AGPL-3.0 -- or $10/year for a permissive license. Based on Starlight by the Astro team.