walkthrough

Installation
SKILL.md

Walkthrough

Turn any source into a deployable learning site: self-contained, offline walkthrough.html "routes" organized by a React/Vite hub (the document center) that also renders plan.md / design.md. You author content for a target audience; a build script renders polished, consistent HTML; CI publishes to GitHub Pages.

Core principle: you author Markdown DSL, not HTML. The build script owns syntax highlighting, diagram rendering, the TOC, quizzes, and progress — so every route is consistent and offline-capable. Hand-writing HTML (or hand-drawing SVG, or hand-tokenizing code) is the anti-pattern this skill exists to prevent.

Audience principle (hard rule): everything that renders in the browser is for the learner and no one else — never the author, a reviewer, or an agent. Never render authoring meta-commentary ("an older draft said…", "myth correction", "verified against source", "don't teach the old version", "TODO"). State the correct thing plainly as settled fact; keep any correction-of-the-source in your reply to the user, not on the page. The build runs an audience linter that flags these; treat hits as defects. See references/pedagogy.mdThe learner is the only reader.

Installs
2
GitHub Stars
10
First Seen
6 days ago
walkthrough — adamos486/skills