Repository navigation
feat: rebuild the showcase as a VitePress documentation site - #46
Merged
Merged
Conversation
Replace the single-page showcase with a multi-page docs site built on VitePress and themed to the 9k design language: every --vp-* variable maps onto a token from src/styles, so the docs follow the system. - A page per component, generated from its registry entry: live demos above their code, gotchas, props/emits/slots read from source, types, and the agent prompt. - Getting started, foundations and guides pages, including a prompt for building a new component in this system. - Local search, sidebar, outline, previous/next, and an RTL toggle for demos. - A Markdown twin of every page at <path>.md, llms.txt as an index of the twins, llms-full.txt, components.json and a sitemap. - Demo templates compile with @vue/compiler-dom, since VitePress ships Vue's runtime-only build. Relates to #35 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Closes #35
What changes for readers
The showcase at design.the9klabs.com was one very long page holding all 60 components. It is now a documentation site built with VitePress and styled in the 9k design language.
/components/<slug>. Each page has live demos above their code, gotchas, the props, emits and slots read from the component's source, its types, and a self-contained agent prompt..md.llms.txt(in the llmstxt.org format) indexes those Markdown pages and opens with the rules.llms-full.txtholds every page in one file.components.jsonstays.rel="alternate", and each page has "Copy page as Markdown" and "View as Markdown" buttons.How it is built
showcase/.vitepress/theme/style.cssmaps every--vp-*variable onto a token fromsrc/styles/, so the docs change when the system does. VitePress and the system both usehtml.dark, so dark mode needs no second mapping.showcase/registry/<Name>.tsbypages/components/[slug].paths.ts. The registry is still the one place a component's docs are written, andshowcaseRegistry.test.tsstill fails when an export has no entry.compileDemocompiles demo templates with@vue/compiler-domitself. The code shown on the page is still the string that renders. Demos sit in.vp-raw, which keeps VitePress's prose styles off the components.showcase/site/pages.ts.llms.txt,llms-full.txt,components.jsonand the sitemap are written inbuildEnd, and a dev middleware serves the same files.prerender.mjs, and the tests that covered them.wrangler.jsonc,showcase-dist/, the workflow),_headersandrobots.txt. The last two moved toshowcase/pages/public/.docs/superpowers/describe the new site.Verification
npm run checkpasses: 1134 tests, format, lint, typecheck, library build, Storybook build, and the docs build (73 pages, 77 machine-readable files).tests/showcaseSite.test.ts:llms.txt;<and>in prose.v-modeldemo updates as you type, with no console warnings.rel="alternate"Markdown link.🤖 Generated with Claude Code