docs-site
Skill2 starsChanged 53 days agoMITView on GitHub
Build a premium documentation site (Claude-docs style) with Astro Starlight, restyled to the design law, deployed free on GitHub Pages. Covers MDX vs Markdown, base-path setup, sidebar, search, and the deploy workflow. Load when the user asks for docs, a documentation site, a knowledge base, or a developer guide site.
5 other projects use a version of this.
Adopted by
Most recently taken up by
- navjyotnishant/nj-agentstheir own version, first seen Oct 15, 2026
- Lee-Dongwook/E2E-Self-Healtheir own version, first seen Oct 9, 2026
- VPDPersonal/Aspid.MVVMtheir own version, first seen Oct 9, 2026
- AmineDjeghri/awesome-os-setuptheir own version, first seen Oct 8, 2026
- sentasity/cadencetheir own version, first seen Aug 5, 2026
Other versions5 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 5
- AmineDjeghri/awesome-os-setup★ 673same name
- VPDPersonal/Aspid.MVVM★ 65same name
- Lee-Dongwook/E2E-Self-Heal★ 9same name
- navjyotnishant/nj-agents★ 1same name
- sentasity/cadence★ 1same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository28 other files it gives its agents.
- anime-jsSkill
- apple-designSkill
- asset-pipelineSkill
- atelier-bootstrapSkill
- atelier-buildSkill
- atelier-clarifySkill
- atelier-doctorSkill
- atelier-learnSkill
- atelier-planSkill
- atelier-promoteSkill
- atelier-reviewSkill
- atelier-shipSkill
- atelier-statusSkill
- atelier-updateSkill
- auth-lawSkill
- clean-code-lawSkill
- deploy-advisorSkill
- design-lawSkill
- gatewaySkill
- living-graphicsSkill
- loop-engineSkill
- mcp-makerSkill
- principal-mindSkill
- security-lawSkill
- stack-guidesSkill
- structure-lawSkill
- web-3dSkill
- web-qualitySkill
The file
We split this skill into the rules it gives an agent
2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.
0
Common
Most of the 4 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 44
Never put raw HTML layout in .md — if a page needs structure, it's .mdx with components.
- Distinctive: line 55
Every page answers one question.
“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Docs Site
The lazy premium answer for documentation is Astro Starlight: dark/light themes, sidebar, mobile nav, and offline full-text search (Pagefind) all built in — you write markdown, it ships a static site. Never hand-roll a docs shell; never reach for Docusaurus (heavier, React runtime) unless the project is already React-docs-committed.
Recipe (proven live at inerate.github.io/docs)
Separate repo — docs never live inside a plugin/library repo users clone.
Name the repo docs under the org → serves at <org>.github.io/docs.
Five files, scaffolded by hand (npm create astro can stall on Windows —
write the files directly, then npm install):
package.json— deps only:astro ^5,@astrojs/starlight ^0.36.astro.config.mjs—site: 'https://<org>.github.io',base: '/docs'(forgettingbasebreaks every asset and link),starlight({ title, sidebar, customCss: ['./src/styles/custom.css'] }). Sidebar groups by audience: Start here / Concepts / Using it / Maintainers.src/content.config.ts—docsLoader()+docsSchema()verbatim.src/styles/custom.css— map Starlight vars to design-law tokens:--sl-color-accent,--sl-color-bg,--sl-color-textfor BOTH:rootand[data-theme='light']. This is the whole restyle..github/workflows/deploy.yml—withastro/action@v3build job +actions/deploy-pages@v4deploy job; enable Pages withgh api repos/<org>/docs/pages -X POST -f build_type=workflow.
Push markdown → live in ~90s. No manual builds ever.
MDX vs Markdown
.md— default for every page. Frontmattertitle+descriptionrequired..mdx— ONLY when a page needs components: Starlight's<Card>,<CardGrid>,<Tabs>,<Steps>,<LinkCard>(import from@astrojs/starlight/components), or custom Astro components. Typical: the landingindex.mdxwith a hero + card grid; everything else stays.md.- Never put raw HTML layout in
.md— if a page needs structure, it's.mdxwith components.
Landing page frontmatter: template: splash, hero: with tagline and
actions — gives the big centered hero without any custom code.
Laws
- Content pages are plain prose + code blocks; components are seasoning,
not structure. One
<CardGrid>per page maximum. - Internal links are root-relative WITH the base:
/docs/start/install/. - Every page answers one question; title says it ("Install & first project", not "Getting Started").
- A
privacy.mdpage (local-only, no telemetry) costs 5 minutes and is required by plugin-marketplace submission forms — add it day one.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.