# slidev-theme-smile

> Smile theme for Slidev

Latest version **0.8.2** (published 2023-04-20) · GPL license · 0 weekly downloads

## Install

```sh
npm install slidev-theme-smile
pnpm add slidev-theme-smile
yarn add slidev-theme-smile
bun add slidev-theme-smile
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.2 |
| Published | 2023-04-20 |
| First published | 2022-01-21 |
| Weekly downloads | 0 |
| License | GPL |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14.0.0 |
| Dependencies | 1 |
| Unpacked size | 993.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Tony Cabaye |
| Maintainers | tonai, marob, smile-sa |
| Keywords | slidev-theme, slidev |

## Links

- npm: https://www.npmjs.com/package/slidev-theme-smile
- Repository: https://github.com/Smile-SA/slidev-theme-smile
- Issues: https://github.com/Smile-SA/slidev-theme-smile/issues
- npm.io page: https://npm.io/package/slidev-theme-smile

## Dependencies (1)

- [@iconify-json/mdi](https://npm.io/package/@iconify-json/mdi.md) ^1.1.43

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.8.2 (latest) — 2023-04-20
- 0.8.1 — 2023-02-10
- 0.8.0 — 2023-01-25
- 0.7.4 — 2023-01-20
- 0.7.3 — 2022-05-23
- 0.7.2 — 2022-05-20
- 0.7.1 — 2022-04-08
- 0.7.0 — 2022-04-06
- 0.6.0 — 2022-03-25
- 0.5.3 — 2022-03-24
- 0.5.2 — 2022-03-23
- 0.5.1 — 2022-03-23
- 0.5.0 — 2022-03-23
- 0.4.0 — 2022-02-25
- 0.3.3 — 2022-02-16
- … 12 more at https://npm.io/package/slidev-theme-smile/versions

## README

# slidev-theme-smile

[![NPM version](https://img.shields.io/npm/v/slidev-theme-smile?color=3AB9D4&label=)](https://www.npmjs.com/package/slidev-theme-smile)

Smile theme for [Slidev](https://github.com/slidevjs/slidev).

<!--
  Learn more about how to write a theme:
  https://sli.dev/themes/write-a-theme.html
--->

<!--
  run `npm run dev` to check out the slides for more details of how to start writing a theme
-->

![Screen capture 01](./assets/screencapture-01.png)
![Screen capture 02](./assets/screencapture-02.png)
![Screen capture 03](./assets/screencapture-03.png)

## 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>smile</b>
---</code></pre>

Learn more about [how to use a theme](https://sli.dev/themes/use).

## Components

This theme provides the following components:

### `Alert`

Display an alert box.

Usage:
```vue
<alert>This is an info</alert>
<alert>

Content with `markdown` should be surrounded by **blank lines**.

</alert>
```

Parameters:

* `type` (type: `'info' | 'warning' | 'error'`, default: `'info'`): Type for the alert

### `DownloadButton`

Display a button you can click to download a file.

Usage (`demo.html` is in the `public` folder):
```vue
<DownloadButton filename="demo.html">Download code</DownloadButton>
```

Or:
```vue
<DownloadButton content="<h1>Hello world!</h3>" filename="demo.html">Download code</DownloadButton>
```

Parameters:

* `content` (type: `string`): Content of the file
* `filename` (type: `string`): Filename of the downloaded file and content file if `content` is empty.
* `type` (type: `string`, default `'text/plain'`): mime type of the content

### `Icon` + `IconSprite`

Display a Smile icon.

Usage:
```vue
<icon-sprite/>
<icon icon="rocket-filled" />
```

You have to include the `IconSprite` component only once and at the beginning of your presentation.

Parameters:

* `class` (type: `string`): HTML class to apply to the icon
* `color` (type: `'primary' | 'secondary'`): Color of the icon
* `icon` (type: `string`, required): The icon name

### `Logo`

Display the Smile logo.

Usage:
```vue
<logo/>
```

Parameters:

* `color` (type: `'white' | 'primary'`, default: `'white`): The main color of the logo
* `iconColor` (type: `'primary' | 'secondary'`, default: `'primary'`): The color of the icons on the logo

### `PaintWorklet`

Import a CSS paintWorklet module.

Usage:
```vue
<PaintWorklet src="https://unpkg.com/@houdini-modules/border-radius-reverse@0.0.1/border-radius-reverse.js"></PaintWorklet>
```

Parameters:

* `src` (type: `string`): Source URL of the worklet to load.

### `vScript`

Like the classical `<script>` tag.

Usage:
```vue
<vScript scoped type="module">
  import intersection from 'https://cdn.jsdelivr.net/npm/lodash-es@4.17.21/intersection.js';
  const result = intersection([1,2,3,4], [2,4,6,8]);
  document.querySelector('#result').innerText = JSON.stringify(result);
</vScript>
```

Parameters:

* `scoped` (type: `boolean`, default: `false`): Wrap the content of the `<script>` with an IIFE to create an isolated scope.
* Other attributes are passed down to the `<script>` tag.

## Layouts

### `two-cols-with-title`

Display two columns with a top content for the title.

Usage:
~~~md
---
layout: two-cols-with-title
---

## Top title

::left::

Left col content

::right::

Right col content
~~~

### `two-cols-demo`

Display code on the left and demo on the right.

Usage:
~~~md
---
layout: two-cols-demo
---

## Demo

::left::

```html
<button class="button" type="button">Click me</button>
```

::right::

<button class="button" type="button">Click me</button>
~~~

## 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

---
_Source: https://npm.io/package/slidev-theme-smile · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._