This project is a Slidev-powered site for teaching topics like Micro:bit, Python, and Cybersecurity. Content is authored in Markdown and enhanced with Vue components and custom layouts.
- Install dependencies:
pnpm install(ornciif using @antfu/ni)
- Start the dev server:
pnpm dev(ornr dev)
- Open http://localhost:3030 in your browser.
slides.md: Main slide deckpages/: Lesson Content (Markdown)components/,layouts/: Vue components and custom layoutspublic/img/: Images and static assetssnippets/: Reusable code samples (Python, TypeScript).github/workflows/deploy.yml: GitHub Pages deployment workflow
- Use frontmatter (
---) for slide metadata (title, layout, background, etc.) - Embed Vue components directly in Markdown
- Reference images from
public/img/ - Use Mermaid diagrams and code blocks for examples
- Add a new slide in pages
- Build:
pnpm build(ornr build) - Output:
dist/folder - Deploy: Automated via GitHub Actions to GitHub Pages
- Prefer
pnpmfor package management, butnci/nrare supported - Keep lessons modular (one topic per Markdown file)
- Use Slidev/Markdown/Vue idioms for authoring
- Slidev: Main framework
- Vue: Custom components/layouts
- Mermaid: Diagrams in Markdown
- GitHub Pages: Static site hosting
- Netlify/Vercel: Config files present, but main deploy is via GitHub Pages
For more details, see .github/copilot-instructions.md and .github/workflows/deploy.yml.