Skip to content

Commit

Permalink
Simplified readme
Browse files Browse the repository at this point in the history
All the info is now in the wiki
  • Loading branch information
0phoff committed Nov 22, 2023
1 parent 339adac commit e7c5402
Show file tree
Hide file tree
Showing 6 changed files with 3 additions and 88 deletions.
91 changes: 3 additions & 88 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A <a href="https://sli.dev">Slidev</a> theme for the <a href="https://www.eavise
<a href="https://0phoff.github.io/slidev-theme-eavise"><img alt="Demo" src="https://img.shields.io/badge/-demo-116E8A"></a>
</p>

## Install
# Install

Add the following frontmatter to your `slides.md`.
Start Slidev, which will then prompt you to install the theme automatically.
Expand All @@ -27,100 +27,15 @@ theme: eavise
Alternatively, you can install the `slidev-theme-eavise` package manually, if you need a specific version.
Learn more about [how to use a theme](https://sli.dev/themes/use).

## Layouts

### cover
<img alt="cover layout" src="screenshots/01.png" width="30%" />

The cover slide page for starting your presentations.

If the first two elements are `<h# />` tags, they get placed in the center of the screen.
This can be used to set a title and subtitle.

| Property | Default | Description |
|:---------------:|:---------------------------:|:------------|
| author | undefined | Author name. |
| date | Today's date (DD MMM YYYY) | Date. |
| image | undefined | Background image (can be url or local file). |
| image-filter | undefined | [CSS filter](https://developer.mozilla.org/en-US/docs/Web/CSS/filter) which is applied to the image only. |
| image-transform | undefined | [CSS transform](https://developer.mozilla.org/en-US/docs/Web/CSS/transform) which is applied to the image only. |
| color | var(--slidev-theme-primary) | Color applied on top of the image. Note that it is applied as a CSS `background` and thus can also contain eg. gradients. |
| color-opacity | 0.75 | Opacity of the color layer (only used if there is an image). |
| text-color | image ? 'white' : 'inherit' | Text color (also changes logo color). |

### default
<img alt="default layout" src="screenshots/02.png" width="30%" />

The default slide layout with a header and footer.

If the first element of the slide is an `<h# />`, it will be placed in the header.
Additionally, you can place your content in the `::content::` slot, which will take all the remaining space after the title.
This allows you to eg. center content on the page.
Finally, the `::content::` slot also allows you to use an `<h# />` element without it becoming a preconfigured header block.

| Property | Default | Description |
|:-------------:|:---------------------------:|:------------|
| color | var(--slidev-theme-primary) | Base color for header and footer. |

### image
<img alt="image layout" src="screenshots/05.png" width="30%" />

A slide with a fullscreen image.

The content in this slide is not positioned.
We recommend using a `<style />` tag where you can position the content by eg. adding a grid/flexbox to your `.slidev-layout`.

| Property | Default | Description |
|:---------------:|:---------------------------:|:------------|
| image | undefined | Background image (can be url or local file). |
| image-filter | undefined | [CSS filter](https://developer.mozilla.org/en-US/docs/Web/CSS/filter) which is applied to the image only. |
| image-transform | undefined | [CSS transform](https://developer.mozilla.org/en-US/docs/Web/CSS/transform) which is applied to the image only. |
| color | undefined | Color applied on top of the image. Note that it is applied as a CSS `background` and thus can also contain eg. gradients. |
| color-opacity | 0.75 | Opacity of the color layer (only used if there is an image). |
| text-color | image ? 'white' : 'inherit' | Text color (sets --text-color var, which can be used by other content as well). |

### section
<img alt="section layout" src="screenshots/04.png" width="30%" />

A slide to separate sections.

This is a simple image layout, with special positioning for the first element (if it is a `<h# />` tag).
This allows you to easily create an image slide with a short title.

Note that if you do not pass a `number`, the slide title will be centered.
If there is a slide number, the layout slightly changes as shown in the screenshot above.

| Property | Default | Description |
|:---------------:|:---------------------------:|:------------|
| number | undefined | Section number. |
| image | undefined | Background image (can be url or local file). |
| image-filter | undefined | [CSS filter](https://developer.mozilla.org/en-US/docs/Web/CSS/filter) which is applied to the image only. |
| image-transform | undefined | [CSS transform](https://developer.mozilla.org/en-US/docs/Web/CSS/transform) which is applied to the image only. |
| color | undefined | Color applied on top of the image. Note that it is applied as a CSS `background` and thus can also contain eg. gradients. |
| color-opacity | 0.75 | Opacity of the color layer (only used if there is an image). |
| text-color | image ? 'white' : 'inherit' | Text color. |


## Components

### IconEavise
The EAVISE icon as an inline SVG.

### LogoEavise
The EAVISE logo as an inline SVG.

### LogoEaviseKUL
The EAVISE + KU Leuven logo as an inline SVG.

## Contributing
# Contributing

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

## License
# License

<p align="center">
MIT License © 2023 <a href="https://github.com/0phoff">0phoff</a>
Expand Down
Binary file removed screenshots/01.png
Binary file not shown.
Binary file removed screenshots/02.png
Binary file not shown.
Binary file removed screenshots/03.png
Binary file not shown.
Binary file removed screenshots/04.png
Binary file not shown.
Binary file removed screenshots/05.png
Binary file not shown.

0 comments on commit e7c5402

Please sign in to comment.