- Dark theme — Modern, easy-on-the-eyes dark design
- Slide transitions — Smooth fade + slide-up effect
- Keyboard navigation — Arrow keys, Space, Home/End
- Touch support — Swipe left/right on mobile
- Fullscreen mode — Press
fto go fullscreen - Progress bar — Visual indicator of your progress
- Slide counter — Current slide / total slides
- Watch mode — Auto-rebuild on file changes (
--watch) - Custom templates — Bring your own HTML template (
--template)
npx md-slides presentation.md
npm install -g md-slides md-slides presentation.md
---
- Point two
- Point three
---
def hello():
print("Hello from md-slides!")
`
---
npx md-slides presentation.md
md-slides <input.md> [options]
Options: -o, --output Output HTML file (default: .html) -t, --template Custom HTML template -w, --watch Watch for changes and rebuild -h, --help Show this help
---
# Basic usage
md-slides talk.md
# Custom output path
md-slides deck.md -o index.html
# Watch mode (auto-rebuild on save)
md-slides presentation.md --watch
# Custom template
md-slides slides.md -t my-template.html
KER More content
Final slide
---
|-----|--------|
| `→` / `↓` / `Space` | Next slide |
| `←` / `↑` | Previous slide |
| `Home` | First slide |
| `End` | Last slide |
| `f` | Toggle fullscreen |
---
- `{{SLIDE_COUNT}}` — Total number of slides
```bash
md-slides deck.md -t my-theme.html
- Portable — Single HTML file you can email, host on GitHub Pages, or open locally
- Focus on content — Write Markdown, get a presentation. That's it.
- Beautiful defaults — Dark theme looks great without any configuration
cd md-slides npm install node index.js example.md -o example.html
---
- 🚀 **Deploy your frontend** on [Vercel](https://vercel.com/?utm_source=scl339&utm_campaign=oss)
- ⭐ **Star this repo** to help others discover it
---
---
## 🤝 赞助支持 (Sponsor)
如果这个项目对你有帮助，可以请我喝杯咖啡 ☕
- 💖 **支付宝 (Alipay)**: `18559219554` | 邮箱联系: `530765059@qq.com`
- ☁️ **DigitalOcean 联盟链接**: [免费 $200 额度](https://m.do.co/c/2ca0db2b48be)
- ⭐ **在 GitHub 上点 Star** 帮助更多人发现这个项目
## 📄 License