ContextQMD
Back to Slidev

README

README.md

52.15.15.3 KB
Original Source
<p align="center"> <a href="https://sli.dev" target="_blank"> </a> </p> <p align="center"> Presentation <b>slide</b>s for <b>dev</b>elopers 🧑‍💻👩‍💻👨‍💻 </p> <p align="center"> <a href="https://www.npmjs.com/package/@slidev/cli" target="__blank"></a> <a href="https://www.npmjs.com/package/@slidev/cli" target="__blank"></a> <a href="https://sli.dev/" target="__blank"></a> <a href="https://sli.dev/resources/theme-gallery" target="__blank"></a>

<a href="https://github.com/slidevjs/slidev/stargazers" target="__blank"></a>

</p> <p align="center"> <a href="https://twitter.com/antfu7/status/1389604687502995457">Video Preview</a> | <a href="https://sli.dev">Documentation</a> </p> <div align="center"> <table> <tbody> <td align="center">

<sub>Made possible by my <a href="https://github.com/sponsors/antfu">Sponsor Program 💖</a></sub>

</td> </tbody> </table> </div>

Features

  • 📝 Markdown-based - focus on content and use your favorite editor
  • 🧑‍💻 Developer Friendly - built-in code highlighting, live coding, etc.
  • 🎨 Themable - theme can be shared and used with npm packages
  • 🌈 Stylish - on-demand utilities via UnoCSS.
  • 🤹 Interactive - embedding Vue components seamlessly
  • 🎙 Presenter Mode - use another window, or even your phone to control your slides
  • 🎨 Drawing - draw and annotate on your slides
  • 🧮 LaTeX - built-in LaTeX math equations support
  • 📰 Diagrams - creates diagrams using textual descriptions with Mermaid
  • 🌟 Icons - access to icons from any icon set directly
  • 💻 Editor - integrated editor, or the VSCode extension
  • 🎥 Recording - built-in recording and camera view
  • 📤 Portable - export into PDF, PNGs, or PPTX
  • ⚡️ Fast - instant reloading powered by Vite
  • 🛠 Hackable - using Vite plugins, Vue components, or any npm packages

Getting Started

Try it Online ⚡️

sli.dev/new

Init Project Locally

Install Node.js >= 20.12.0 and run the following command:

bash
npm init slidev

Documentation: English | 中文文档 | Français | Español | Русский | Português-BR

Discord: chat.sli.dev

For a full example, you can check the demo folder, which is also the source file for my previous talk.

Tech Stack

  • Vite - An extremely fast frontend tooling
  • Vue 3 powered Markdown - Focus on the content while having the power of HTML and Vue components whenever needed
  • UnoCSS - On-demand utility-first CSS engine, style your slides at ease
  • Shiki, Monaco Editor - First-class code snippets support with live coding capability
  • RecordRTC - Built-in recording and camera view
  • VueUse family - @vueuse/core, @vueuse/motion, etc.
  • Iconify - Icon sets collection.
  • Drauu - Drawing and annotations support
  • KaTeX - LaTeX math rendering.
  • Mermaid - Textual Diagrams.

Sponsors

This project is made possible by all the sponsors supporting my work:

<p align="center"> <a href="https://github.com/sponsors/antfu"> </a> </p>

License

MIT License © 2021 Anthony Fu