From e5e91279628e18ad9232e5f8e547682ab98fa734 Mon Sep 17 00:00:00 2001 From: ahandsel Date: Mon, 21 Mar 2022 06:01:13 +0900 Subject: [PATCH 1/6] Markdown stye: Indent bullet points --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c973829..5c75f5d 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ [![NPM version](https://img.shields.io/npm/v/slidev-theme-light-icons?color=3AB9D4&label=)](https://www.npmjs.com/package/slidev-theme-light-icons) -- A light and Elegant theme for [Slidev](https://github.com/slidevjs/slidev). -- This theme contains collection of amazing & light-weighted icons called the `light-icons`. + - A light and Elegant theme for [Slidev](https://github.com/slidevjs/slidev). + - This theme contains collection of amazing & light-weighted icons called the `light-icons`. #### Live demo: [Click Here](https://slidev.icons.lightvue.org). @@ -203,16 +203,16 @@ layout: center-image This theme provides the following components: ### `LightIcon` & `IconBox` -- For using `light-icons` wherever needed inside the theme. -- Also packed with additional `IconBox` to make the icons look elegant. + - For using `light-icons` wherever needed inside the theme. + - Also packed with additional `IconBox` to make the icons look elegant. ![dynamic-image](screenshot/9-layout-dynamic-image-light.png) ## 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 genreate the preview PDF - `npm run screenshot` to genrate the preview PNG + - `npm install` + - `npm run dev` to start theme preview of `example.md` + - Edit the `example.md` and style to see the changes From 05e127e5720229a933206d56640ea568c42b3857 Mon Sep 17 00:00:00 2001 From: ahandsel Date: Mon, 21 Mar 2022 06:01:32 +0900 Subject: [PATCH 2/6] Markdown style: Format headers --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5c75f5d..f8c8a47 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,13 @@ - A light and Elegant theme for [Slidev](https://github.com/slidevjs/slidev). - This theme contains collection of amazing & light-weighted icons called the `light-icons`. -#### Live demo: [Click Here](https://slidev.icons.lightvue.org). +#### Live demo: [Click Here](https://slidev.icons.lightvue.org) For more information about `light-icons`. Visit [Light Icons](https://lightvue.org/getting-started/light-icons). --- -### 100% Light & Dark Compatible +### 100% Light & Dark Compatible All themes are compatible with `light` & `dark` mode ![image-header-intro](screenshot/overall.gif) From 15210890fbd5a1c08b4328e9299789a6c5b15f29 Mon Sep 17 00:00:00 2001 From: ahandsel Date: Mon, 21 Mar 2022 06:02:13 +0900 Subject: [PATCH 3/6] Markdown Style: Add code type --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index f8c8a47..b8bbd30 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ This theme provides the following layouts: #### Intro `intro` Usage: -``` +```markdown --- layout: intro image: 'https://source.unsplash.com/collection/94734566/1920x1080' @@ -47,7 +47,7 @@ image: 'https://source.unsplash.com/collection/94734566/1920x1080' #### Intro with icon `image-header-intro` Usage: -``` +```markdown --- layout: image-header-intro imageHeader: '../assets/images/light-icon-logo.svg' @@ -62,7 +62,7 @@ imageRight: '../assets/images/light-icons-landing.svg' #### Dynamic Image `dynamic-image` Usage: -``` +```markdown --- layout: dynamic-image image: 'https://source.unsplash.com/collection/94734566/1920x1080' @@ -78,7 +78,7 @@ left: false #### Dynamic Image `dynamic-image` Usage: -``` +```markdown --- layout: dynamic-image image: 'https://source.unsplash.com/collection/94734566/1920x1080' @@ -94,7 +94,7 @@ left: false #### Dynamic Image `dynamic-image` Usage: -``` +```markdown --- layout: dynamic-image image: 'https://source.unsplash.com/collection/94734566/1920x1080' @@ -110,7 +110,7 @@ left: true #### Dynamic Image `dynamic-image` Usage: -``` +```markdown --- layout: dynamic-image image: 'https://source.unsplash.com/collection/94734566/1920x1080' @@ -126,7 +126,7 @@ left: false #### Dynamic Image `dynamic-image` Usage: -``` +```markdown --- layout: dynamic-image image: 'https://source.unsplash.com/collection/94734566/1920x1080' @@ -143,7 +143,7 @@ left: false #### Image at center `dynamic-image` Usage: -``` +```markdown --- layout: center-image image: '../assets/images/light-icons-landing2.png' @@ -157,7 +157,7 @@ image: '../assets/images/light-icons-landing2.png' #### Dynamic Image `dynamic-image` Usage: -``` +```markdown --- layout: dynamic-image image: 'https://source.unsplash.com/collection/94734566/1920x1080' @@ -175,7 +175,7 @@ left: false #### Image at left `left-image` Usage: -``` +```markdown --- layout: left-image image: '../assets/images/light-vue-landing.svg' @@ -189,7 +189,7 @@ equal: true #### Image at center `dynamic-image` Usage: -``` +```markdown --- layout: center-image --- From a266ddc3f1cd17f8812cbbe13cc1dc11cb3268f0 Mon Sep 17 00:00:00 2001 From: ahandsel Date: Mon, 21 Mar 2022 06:02:26 +0900 Subject: [PATCH 4/6] Markdown style: Consistency --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b8bbd30..b11376f 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ Learn more about [how to use a theme](https://sli.dev/themes/use). ## Layouts This theme provides the following layouts: + #### Intro `intro` Usage: @@ -43,7 +44,6 @@ image: 'https://source.unsplash.com/collection/94734566/1920x1080' --- - #### Intro with icon `image-header-intro` Usage: From 81c071b66888a86068d665ea8764a0c943db9849 Mon Sep 17 00:00:00 2001 From: ahandsel Date: Mon, 21 Mar 2022 06:02:36 +0900 Subject: [PATCH 5/6] Typo fix --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b11376f..9aa6f89 100644 --- a/README.md +++ b/README.md @@ -211,8 +211,8 @@ This theme provides the following components: ## Contributing -- `npm run export` to genreate the preview PDF -- `npm run screenshot` to genrate the preview PNG - `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 From 9d561958453f166e6b06d930d3453a983f4aba35 Mon Sep 17 00:00:00 2001 From: ahandsel Date: Mon, 21 Mar 2022 06:21:55 +0900 Subject: [PATCH 6/6] Critical Fix: image-left is the correct layout name "left-image" layout should be "image-left" on Readme.md Readme.md mentions the layout which arrange the Image on Left side of page by specifying "left-image" on layout tag, but it should be "image-left". https://github.com/lightvue/slidev-theme-light-icons/issues/3 --- README.md | 4 ++-- ...image-dark.png => 10-layout-image-left-dark.png} | Bin ...age-light.png => 10-layout-image-left-light.png} | Bin ...image-dark.png => 10-layout-image-left-dark.png} | Bin ...age-light.png => 10-layout-image-left-light.png} | Bin 5 files changed, 2 insertions(+), 2 deletions(-) rename screenshot/{10-layout-left-image-dark.png => 10-layout-image-left-dark.png} (100%) rename screenshot/{10-layout-left-image-light.png => 10-layout-image-left-light.png} (100%) rename screenshot/hd/{10-layout-left-image-dark.png => 10-layout-image-left-dark.png} (100%) rename screenshot/hd/{10-layout-left-image-light.png => 10-layout-image-left-light.png} (100%) diff --git a/README.md b/README.md index 9aa6f89..f9c6fa1 100644 --- a/README.md +++ b/README.md @@ -172,12 +172,12 @@ left: false --- -#### Image at left `left-image` +#### Image at left `image-left` Usage: ```markdown --- -layout: left-image +layout: image-left image: '../assets/images/light-vue-landing.svg' equal: true --- diff --git a/screenshot/10-layout-left-image-dark.png b/screenshot/10-layout-image-left-dark.png similarity index 100% rename from screenshot/10-layout-left-image-dark.png rename to screenshot/10-layout-image-left-dark.png diff --git a/screenshot/10-layout-left-image-light.png b/screenshot/10-layout-image-left-light.png similarity index 100% rename from screenshot/10-layout-left-image-light.png rename to screenshot/10-layout-image-left-light.png diff --git a/screenshot/hd/10-layout-left-image-dark.png b/screenshot/hd/10-layout-image-left-dark.png similarity index 100% rename from screenshot/hd/10-layout-left-image-dark.png rename to screenshot/hd/10-layout-image-left-dark.png diff --git a/screenshot/hd/10-layout-left-image-light.png b/screenshot/hd/10-layout-image-left-light.png similarity index 100% rename from screenshot/hd/10-layout-left-image-light.png rename to screenshot/hd/10-layout-image-left-light.png