| 1 | # {{package-name}} |
| 2 | |
| 3 | [](https://www.npmjs.com/package/{{package-name}}) |
| 4 | |
| 5 | A (...) theme for [Slidev](https://github.com/slidevjs/slidev). |
| 6 | |
| 7 | <!-- |
| 8 | Learn more about how to write a theme: |
| 9 | https://sli.dev/guide/write-theme.html |
| 10 | ---> |
| 11 | |
| 12 | <!-- |
| 13 | run `npm run dev` to check out the slides for more details of how to start writing a theme |
| 14 | --> |
| 15 | |
| 16 | <!-- |
| 17 | Put some screenshots here to demonstrate your theme |
| 18 | |
| 19 | Live demo: [...] |
| 20 | --> |
| 21 | |
| 22 | ## Install |
| 23 | |
| 24 | Add the following frontmatter to your `slides.md`. Start Slidev then it will prompt you to install the theme automatically. |
| 25 | |
| 26 | <pre><code>--- |
| 27 | theme: <b>{{name}}</b> |
| 28 | ---</code></pre> |
| 29 | |
| 30 | Learn more about [how to use a theme](https://sli.dev/guide/theme-addon#use-theme). |
| 31 | |
| 32 | ## Layouts |
| 33 | |
| 34 | This theme provides the following layouts: |
| 35 | |
| 36 | > TODO: |
| 37 | |
| 38 | ## Components |
| 39 | |
| 40 | This theme provides the following components: |
| 41 | |
| 42 | > TODO: |
| 43 | |
| 44 | ## Contributing |
| 45 | |
| 46 | - `npm install` |
| 47 | - `npm run dev` to start theme preview of `example.md` |
| 48 | - Edit the `example.md` and style to see the changes |
| 49 | - `npm run export` to generate the preview PDF |
| 50 | - `npm run screenshot` to generate the preview PNG |
| 51 |