From e7c54027b2668002bde98d234d12b96e7fe29f3f Mon Sep 17 00:00:00 2001 From: 0phoff <0phoff@users.noreply.github.com> Date: Wed, 22 Nov 2023 15:00:31 +0100 Subject: [PATCH] Simplified readme All the info is now in the wiki --- README.md | 91 ++------------------------------------------- screenshots/01.png | Bin 267082 -> 0 bytes screenshots/02.png | Bin 58993 -> 0 bytes screenshots/03.png | Bin 54371 -> 0 bytes screenshots/04.png | Bin 815003 -> 0 bytes screenshots/05.png | Bin 469361 -> 0 bytes 6 files changed, 3 insertions(+), 88 deletions(-) delete mode 100644 screenshots/01.png delete mode 100644 screenshots/02.png delete mode 100644 screenshots/03.png delete mode 100644 screenshots/04.png delete mode 100644 screenshots/05.png diff --git a/README.md b/README.md index ba490cf..bfac1a1 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ A Slidev theme for the Demo

-## Install +# Install Add the following frontmatter to your `slides.md`. Start Slidev, which will then prompt you to install the theme automatically. @@ -27,92 +27,7 @@ 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 -cover layout - -The cover slide page for starting your presentations. - -If the first two elements are `` 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 -default layout - -The default slide layout with a header and footer. - -If the first element of the slide is an ``, 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 `` element without it becoming a preconfigured header block. - -| Property | Default | Description | -|:-------------:|:---------------------------:|:------------| -| color | var(--slidev-theme-primary) | Base color for header and footer. | - -### image -image layout - -A slide with a fullscreen image. - -The content in this slide is not positioned. -We recommend using a `