51 lines
1.1 KiB
Markdown
51 lines
1.1 KiB
Markdown
|
# slidev-theme-narduin
|
||
|
|
||
|
[![NPM version](https://img.shields.io/npm/v/slidev-theme-narduin?color=3AB9D4&label=)](https://www.npmjs.com/package/slidev-theme-narduin)
|
||
|
|
||
|
A (...) theme for [Slidev](https://github.com/slidevjs/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>narduin</b>
|
||
|
---</code></pre>
|
||
|
|
||
|
Learn more about [how to use a theme](https://sli.dev/guide/theme-addon#use-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
|