Skip to content

Commit d2b1633

Browse files
committed
update docs
1 parent ab82161 commit d2b1633

File tree

3 files changed

+33
-23
lines changed

3 files changed

+33
-23
lines changed

README.md

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,22 @@
99
<a href="https://www.npmjs.com/package/vue-final-modal"><img src="https://img.shields.io/npm/l/vue-final-modal.svg?sanitize=true" alt="License"></a>
1010
</p>
1111

12+
### [Documentation](https://hunterliu1003.github.io/vue-final-modal/)
13+
### [Examples](https://hunterliu1003.github.io/vue-final-modal/examples)
14+
### [CDN example](https://codepen.io/hunterliu1003/pen/PoZmbPm?editors=1010)
15+
1216
## Introduction
1317

14-
Simple to use, stackable, detachable, highly customizable, mobile-friendly Vue.js 2.0+ modal with SSR support.
18+
features:
19+
- Tailwind CSS friendly
20+
- Renderless component
21+
- SSR support
22+
- Stackable
23+
- Detachable
24+
- Scrollable
25+
- Transition support
26+
- Mobile friendly
27+
- 3.2kb gzipped
1528

1629
`vue-final-modal` has no predefined styles.
1730
There are only three classes inside `vue-final-modal`, including `.vfm__containter`, `.vfm__content`, `.vfm__overlay`. These classes have only the necessary styles and you can still easily override these styles through these props: `classes`, `content-class`, `overlay-class`
@@ -29,10 +42,6 @@ Here is the simplified template of entire vue-final-modal
2942
</div>
3043
```
3144

32-
## Demo
33-
34-
https://hunterliu1003.github.io/vue-final-modal/
35-
3645
## Install
3746

3847
NPM:
@@ -46,18 +55,6 @@ Yarn:
4655
yarn add vue-final-modal
4756
```
4857

49-
## CDN
50-
51-
https://www.jsdelivr.com/package/npm/vue-final-modal
52-
53-
UMD builds can be used directly in the browser via a `<script>` tag.
54-
55-
```html
56-
<script src="https://cdn.jsdelivr.net/npm/vue-final-modal"></script>
57-
```
58-
59-
[codepen example](https://codepen.io/hunterliu1003/pen/PoZmbPm?editors=1010)
60-
6158
## How to use
6259

6360
```html
@@ -130,6 +127,20 @@ export default {
130127
</div>
131128
```
132129

130+
## CDN
131+
132+
### jsDelivr
133+
134+
```html
135+
<script src="https://cdn.jsdelivr.net/npm/vue-final-modal"></script>
136+
```
137+
138+
### Unpkg
139+
140+
```html
141+
<script src="https://unpkg.com/vue-final-modal"></script>
142+
```
143+
133144
## Roadmap
134145

135146
If you have any ideas for optimization of `vue-final-modal`, feel free to open issues.
@@ -138,7 +149,6 @@ These are the features that will be added in the comming weeks:
138149

139150
- draggable modal
140151
- resizable
141-
- set customize z-index property
142152
- duplicate overlay property
143153
- dynamic emit modal component with vue directive like:
144154
- `this.$modal.show('hello-world')`

docs/content/en/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ description: 'Vue Final Modal is a renderless, stackable, detachable and lightwe
44
position: 0
55
category: Getting Start
66
features:
7-
- TailwindCSS friendly
7+
- Tailwind CSS friendly
88
- Renderless component
99
- SSR support
1010
- Stackable
1111
- Detachable
1212
- Scrollable
1313
- Transition support
1414
- Mobile friendly
15-
- 11kb gzipped
15+
- 3.2kb gzipped
1616
---
1717

1818
<img src="/vue-final-modal/preview.png" class="light-img" />

docs/content/en/setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,19 +72,19 @@ Vue.component('VueFinalModal', VueFinalModal)
7272

7373
## CDN
7474

75-
- https://www.jsdelivr.com/package/npm/vue-final-modal
75+
### jsDelivr
7676

7777
```html
7878
<script src="https://cdn.jsdelivr.net/npm/vue-final-modal"></script>
7979
```
8080

81-
- https://unpkg.com/vue-final-modal
81+
### Unpkg
8282

8383
```html
8484
<script src="https://unpkg.com/vue-final-modal"></script>
8585
```
8686

87-
## How to use
87+
## Codepen Example
8888

8989
<iframe height="265" style="width: 100%;" scrolling="no" title="Vue Final Modal" src="https://codepen.io/hunterliu1003/embed/PoZmbPm?height=265&theme-id=dark&default-tab=html,result" frameborder="no" loading="lazy" allowtransparency="true" allowfullscreen="true">
9090
See the Pen <a href='https://codepen.io/hunterliu1003/pen/PoZmbPm'>Vue Final Modal</a> by Hunter

0 commit comments

Comments
 (0)