| 1 | <br> |
| 2 | <p align="center"> |
| 3 | <a href="https://sli.dev" target="_blank"> |
| 4 | <img src="https://sli.dev/logo-title.png" alt="Slidev" height="250" width="250"/> |
| 5 | </a> |
| 6 | </p> |
| 7 | |
| 8 | <p align="center"> |
| 9 | Presentation <b>slide</b>s for <b>dev</b>elopers 🧑💻👩💻👨💻 |
| 10 | </p> |
| 11 | |
| 12 | <p align="center"> |
| 13 | <a href="https://www.npmjs.com/package/@slidev/cli" target="__blank"><img src="https://img.shields.io/npm/v/@slidev/cli?color=2B90B6&label=" alt="NPM version"></a> |
| 14 | <a href="https://www.npmjs.com/package/@slidev/cli" target="__blank"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@slidev/cli?color=349dbe&label="></a> |
| 15 | <a href="https://sli.dev/" target="__blank"><img src="https://img.shields.io/static/v1?label=&message=docs%20%26%20demos&color=45b8cd" alt="Docs & Demos"></a> |
| 16 | <a href="https://sli.dev/resources/theme-gallery" target="__blank"><img src="https://img.shields.io/static/v1?label=&message=themes&color=4ec5d4" alt="Themes"></a> |
| 17 | <br> |
| 18 | <a href="https://github.com/slidevjs/slidev/stargazers" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/slidevjs/slidev?style=social"></a> |
| 19 | </p> |
| 20 | |
| 21 | <p align="center"> |
| 22 | <a href="https://x.com/antfu7/status/1389604687502995457">Video Preview</a> | <a href="https://sli.dev">Documentation</a> |
| 23 | </p> |
| 24 | |
| 25 | <div align="center"> |
| 26 | <table> |
| 27 | <tbody> |
| 28 | <td align="center"> |
| 29 | <img width="2000" height="0" alt="" aria-hidden><br> |
| 30 | <sub>Made possible by my <a href="https://github.com/sponsors/antfu">Sponsor Program 💖</a></sub><br> |
| 31 | <img width="2000" height="0" alt="" aria-hidden> |
| 32 | </td> |
| 33 | </tbody> |
| 34 | </table> |
| 35 | </div> |
| 36 | |
| 37 | ## Features |
| 38 | |
| 39 | - 📝 [**Markdown-based**](https://sli.dev/guide/syntax) - focus on content and use your favorite editor |
| 40 | - 🧑💻 [**Developer Friendly**](https://sli.dev/guide/syntax#code-blocks) - built-in code highlighting, live coding, etc. |
| 41 | - 🎨 [**Themable**](https://sli.dev/resources/theme-gallery) - theme can be shared and used with npm packages |
| 42 | - 🌈 [**Stylish**](https://sli.dev/guide/syntax#embedded-styles) - on-demand utilities via [UnoCSS](https://github.com/unocss/unocss). |
| 43 | - 🤹 [**Interactive**](https://sli.dev/custom/directory-structure#components) - embedding Vue components seamlessly |
| 44 | - 🎙 [**Presenter Mode**](https://sli.dev/guide/ui#presenter-mode) - use another window, or even your phone to control your slides |
| 45 | - 🎨 [**Drawing**](https://sli.dev/features/drawing) - draw and annotate on your slides |
| 46 | - 🧮 [**LaTeX**](https://sli.dev/features/latex) - built-in LaTeX math equations support |
| 47 | - 📰 [**Diagrams**](https://sli.dev/guide/syntax#diagrams) - creates diagrams using textual descriptions with [Mermaid](https://mermaid.js.org/) |
| 48 | - 🌟 [**Icons**](https://sli.dev/features/icons) - access to icons from any icon set directly |
| 49 | - 💻 [**Editor**](https://sli.dev/guide/index#editor) - integrated editor, or the [VSCode extension](https://sli.dev/features/vscode-extension) |
| 50 | - 🎥 [**Recording**](https://sli.dev/features/recording) - built-in recording and camera view |
| 51 | - 📤 [**Portable**](https://sli.dev/guide/exporting) - export into PDF, PNGs, or PPTX |
| 52 | - ⚡️ [**Fast**](https://vitejs.dev) - instant reloading powered by [Vite](https://vitejs.dev) |
| 53 | - 🛠 [**Hackable**](https://sli.dev/custom/) - using Vite plugins, Vue components, or any npm packages |
| 54 | |
| 55 | ## Getting Started |
| 56 | |
| 57 | ### Try it Online ⚡️ |
| 58 | |
| 59 | [sli.dev/new](https://sli.dev/new) |
| 60 | |
| 61 | [](https://sli.dev/new) |
| 62 | |
| 63 | ### Init Project Locally |
| 64 | |
| 65 | Install [Node.js >= 20.12.0](https://nodejs.org/) and run the following command: |
| 66 | |
| 67 | ```bash |
| 68 | npm init slidev |
| 69 | ``` |
| 70 | |
| 71 | Documentation: |
| 72 | **[English](https://sli.dev)** | [中文文档](https://cn.sli.dev) | [Français](https://fr.sli.dev) | [Español](https://es.sli.dev) | [Русский](https://ru.sli.dev) | [Português-BR](https://br.sli.dev) |
| 73 | |
| 74 | Discord: [chat.sli.dev](https://chat.sli.dev) |
| 75 | |
| 76 | For a full example, you can check the [demo](https://github.com/slidevjs/slidev/blob/main/demo) folder, which is also the source file for [my previous talk](https://antfu.me/posts/composable-vue-vueday-2021). |
| 77 | |
| 78 | ## Tech Stack |
| 79 | |
| 80 | - [Vite](https://vitejs.dev) - An extremely fast frontend tooling |
| 81 | - [Vue 3](https://v3.vuejs.org/) powered [Markdown](https://daringfireball.net/projects/markdown/syntax) - Focus on the content while having the power of HTML and Vue components whenever needed |
| 82 | - [UnoCSS](https://github.com/unocss/unocss) - On-demand utility-first CSS engine, style your slides at ease |
| 83 | - [Shiki](https://github.com/shikijs/shiki), [Monaco Editor](https://github.com/Microsoft/monaco-editor) - First-class code snippets support with live coding capability |
| 84 | - [RecordRTC](https://recordrtc.org) - Built-in recording and camera view |
| 85 | - [VueUse](https://vueuse.org) family - [`@vueuse/core`](https://github.com/vueuse/vueuse), [`@vueuse/motion`](https://github.com/vueuse/motion), etc. |
| 86 | - [Iconify](https://iconify.design/) - Icon sets collection. |
| 87 | - [Drauu](https://github.com/antfu/drauu) - Drawing and annotations support |
| 88 | - [KaTeX](https://katex.org/) - LaTeX math rendering. |
| 89 | - [Mermaid](https://mermaid-js.github.io/mermaid) - Textual Diagrams. |
| 90 | |
| 91 | ## Sponsors |
| 92 | |
| 93 | This project is made possible by all the sponsors supporting my work: |
| 94 | |
| 95 | <p align="center"> |
| 96 | <a href="https://github.com/sponsors/antfu"> |
| 97 | <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg' alt="Logos from Sponsors" /> |
| 98 | </a> |
| 99 | </p> |
| 100 | |
| 101 | ## License |
| 102 | |
| 103 | MIT License © 2021 [Anthony Fu](https://github.com/antfu) |
| 104 |