Back to Slidev

{{package-name}}

packages/create-theme/template/README.md

52.15.11.1 KB
Original Source

{{package-name}}

A (...) theme for Slidev.

<!-- Learn more about how to write a theme: https://sli.dev/guide/write-theme.html ---> <!-- run `npm run dev` to check out the slides for more details of how to start writing a theme --> <!-- Put some screenshots here to demonstrate your theme Live demo: [...] -->

Install

Add the following frontmatter to your slides.md. Start Slidev then it will prompt you to install the theme automatically.

<pre><code>--- theme: <b>{{name}}</b> ---</code></pre>

Learn more about how to use a theme.

Layouts

This theme provides the following layouts:

TODO:

Components

This theme provides the following components:

TODO:

Contributing

  • npm install
  • npm run dev to start theme preview of example.md
  • Edit the example.md and style to see the changes
  • npm run export to generate the preview PDF
  • npm run screenshot to generate the preview PNG