|
| 1 | +# Quick Reference Card |
| 2 | + |
| 3 | +## 🚀 Quick Start (3 Steps) |
| 4 | +```bash |
| 5 | +1. task install # Install dependencies |
| 6 | +2. task new -- my-presentation # Create presentation |
| 7 | +3. task serve # Preview at localhost:8000 |
| 8 | +``` |
| 9 | + |
| 10 | +## 📋 All Commands |
| 11 | +| Command | What It Does | |
| 12 | +|---------|-------------| |
| 13 | +| `task install` | Install Node.js dependencies | |
| 14 | +| `task new -- <name>` | Create new presentation from template | |
| 15 | +| `task serve` | Start local dev server (port 8000) | |
| 16 | +| `task list` | List all presentations | |
| 17 | +| `task update-index` | Generate presentations array | |
| 18 | +| `task clean` | Clean generated files | |
| 19 | + |
| 20 | +## 📂 File Locations |
| 21 | +``` |
| 22 | +presentations/my-presentation/index.html ← Edit your slides here |
| 23 | +index.html ← Add to presentations array |
| 24 | +CONTRIBUTING.md ← Full documentation |
| 25 | +``` |
| 26 | + |
| 27 | +## ⌨️ Presentation Navigation |
| 28 | +| Key | Action | |
| 29 | +|-----|--------| |
| 30 | +| `→` / `←` | Next/Previous slide | |
| 31 | +| `↑` / `↓` | Up/Down (vertical slides) | |
| 32 | +| `F` | Fullscreen | |
| 33 | +| `S` | Speaker notes view | |
| 34 | +| `ESC` | Slide overview | |
| 35 | + |
| 36 | +## 🎨 Change Theme |
| 37 | +Edit your presentation's HTML: |
| 38 | +```html |
| 39 | +<!-- Change from black.css to any theme: --> |
| 40 | +<link rel="stylesheet" href="../../node_modules/reveal.js/dist/theme/white.css"> |
| 41 | +``` |
| 42 | + |
| 43 | +Available: black, white, league, beige, sky, night, serif, simple, solarized, moon, dracula, blood |
| 44 | + |
| 45 | +## 📝 Basic Slide Structure |
| 46 | +```html |
| 47 | +<!-- Simple slide --> |
| 48 | +<section> |
| 49 | + <h2>Title</h2> |
| 50 | + <p>Content</p> |
| 51 | +</section> |
| 52 | + |
| 53 | +<!-- Vertical slides --> |
| 54 | +<section> |
| 55 | + <section><h2>Main Topic</h2></section> |
| 56 | + <section><h2>Detail 1</h2></section> |
| 57 | + <section><h2>Detail 2</h2></section> |
| 58 | +</section> |
| 59 | + |
| 60 | +<!-- Code with highlighting --> |
| 61 | +<section> |
| 62 | + <pre><code data-trim> |
| 63 | +function hello() { |
| 64 | + console.log("Hello!"); |
| 65 | +} |
| 66 | + </code></pre> |
| 67 | +</section> |
| 68 | + |
| 69 | +<!-- Step-by-step reveal --> |
| 70 | +<section> |
| 71 | + <p class="fragment">First</p> |
| 72 | + <p class="fragment">Second</p> |
| 73 | + <p class="fragment">Third</p> |
| 74 | +</section> |
| 75 | +``` |
| 76 | + |
| 77 | +## 🌐 URL Structure |
| 78 | +After deployment: |
| 79 | +``` |
| 80 | +https://codebaseinterface.org/presentations/my-presentation/ |
| 81 | +``` |
| 82 | + |
| 83 | +## 🔄 Workflow |
| 84 | +1. **Create:** `task new -- presentation-name` |
| 85 | +2. **Edit:** `presentations/presentation-name/index.html` |
| 86 | +3. **Test:** `task serve` → http://localhost:8000 |
| 87 | +4. **List:** `task update-index` → copy to index.html |
| 88 | +5. **Deploy:** Push to main branch (auto-deploys via GitHub Actions) |
| 89 | + |
| 90 | +## 💡 Pro Tips |
| 91 | +- Use `class="fragment"` for step-by-step reveals |
| 92 | +- Press `S` during presentation for speaker notes |
| 93 | +- Use vertical slides (nested sections) for related content |
| 94 | +- Test in fullscreen mode (`F` key) before presenting |
| 95 | +- Add speaker notes inside `<aside class="notes">` tags |
| 96 | + |
| 97 | +## 🆘 Need Help? |
| 98 | +- Full guide: See `CONTRIBUTING.md` |
| 99 | +- Reveal.js docs: https://revealjs.com/ |
| 100 | +- Issues: GitHub repository issues |
| 101 | + |
| 102 | +## ✅ Checklist for New Presentation |
| 103 | +- [ ] Run `task new -- presentation-name` |
| 104 | +- [ ] Edit slides in `presentations/presentation-name/index.html` |
| 105 | +- [ ] Test locally with `task serve` |
| 106 | +- [ ] Add entry to `index.html` presentations array |
| 107 | +- [ ] Commit and push to trigger deployment |
| 108 | +- [ ] Verify live at codebaseinterface.org/presentations/presentation-name/ |
0 commit comments