Skip to content

Commit

Permalink
UPDATED: README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
BashCloud committed May 16, 2021
1 parent f5157ee commit 0155331
Showing 1 changed file with 32 additions and 32 deletions.
64 changes: 32 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@

For more information about `light-icons`. Visit [Light Icons](https://lightvue.org/getting-started/light-icons).

---

### 100% Light & Dark Compatible
All themes are compatible with `light` & `dark` mode

![image-header-intro](screenshot/7-layout-dynamic-image-light.png)

## Install

Add the following frontmatter to your `slides.md`. Start Slidev then it will prompt you to install the theme automatically.
Expand All @@ -32,7 +39,7 @@ image: 'https://source.unsplash.com/collection/94734566/1920x1080'
---
```

![intro](https://i.imgur.com/RxfnAIY.png)
![intro](screenshot/1-layout-intro.png)

---

Expand All @@ -48,22 +55,7 @@ imageRight: '../assets/images/light-icons-landing.svg'
---
```

![image-header-intro](https://i.imgur.com/g0EIbyN.png)

---

#### Image at left `image-left`
Usage:

```
---
layout: image-left
image: '../assets/images/light-vue-landing.svg'
equal: true
---
```

![image-left](https://i.imgur.com/lEDvqkD.png)
![image-header-intro](screenshot/2-layout-image-header-intro-light.png)

---

Expand All @@ -79,7 +71,7 @@ left: false
---
```

![dynamic-image](https://i.imgur.com/TPiRpTf.png)
![dynamic-image](screenshot/3-layout-dynamic-image-dark.png)

---

Expand All @@ -95,7 +87,7 @@ left: false
---
```

![dynamic-image](https://i.imgur.com/IPZqo4h.png)
![dynamic-image](screenshot/4-layout-dynamic-image-dark.png)

---

Expand All @@ -111,7 +103,7 @@ left: true
---
```

![dynamic-image](https://i.imgur.com/JFy7wsu.png)
![dynamic-image](screenshot/5-layout-dynamic-image-dark.png)

---

Expand All @@ -127,7 +119,7 @@ left: false
---
```

![dynamic-image](https://i.imgur.com/oyXH7FL.png)
![dynamic-image](screenshot/6-layout-dynamic-image-dark.png)

---

Expand All @@ -144,7 +136,7 @@ left: false
---
```

![dynamic-image](https://i.imgur.com/47LFHW2.png)
![dynamic-image](screenshot/7-layout-dynamic-image-dark.png)

---

Expand All @@ -158,7 +150,7 @@ image: '../assets/images/light-icons-landing2.png'
---
```

![center-image](https://i.imgur.com/mlzLTbD.png)
![center-image](screenshot/8-layout-center-image-light.png)

---

Expand All @@ -174,28 +166,36 @@ left: false
---
```

![dynamic-image](https://i.imgur.com/py8YL0P.png)
![dynamic-image](screenshot/9-layout-dynamic-image-light.png)

---

---

#### Image at center `dynamic-image`
#### Image at left `left-image`
Usage:

```
---
layout: center-image
layout: left-image
image: '../assets/images/light-vue-landing.svg'
equal: true
---
```

![center-image](https://i.imgur.com/hUR2PsM.png)
![image-left](screenshot/10-layout-left-image-light.png)

---

### Light & Dark Compatible
All themes are compatible with `light` & `dark` mode
#### Image at center `dynamic-image`
Usage:

```
---
layout: center-image
---
```

![image-header-intro](https://i.imgur.com/4dv6K0g.png)
![center-image](screenshot/11-layout-center-image-light.png)


## Components
Expand All @@ -206,7 +206,7 @@ This theme provides the following components:
- For using `light-icons` wherever needed inside the theme.
- Also packed with additional `IconBox` to make the icons look elegant.

![dynamic-image](https://i.imgur.com/py8YL0P.png)
![dynamic-image](screenshot/9-layout-dynamic-image-light.png)


## Contributing
Expand Down

0 comments on commit 0155331

Please sign in to comment.