Skip to content

Commit

Permalink
Rename 'Getting Started' to 'Installation' and rework confusing infor…
Browse files Browse the repository at this point in the history
…mation
  • Loading branch information
mesqueeb committed Oct 16, 2021
1 parent 807d4cd commit 7cd67f0
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 47 deletions.
4 changes: 2 additions & 2 deletions packages/docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,8 @@ module.exports = {
link: '/introduction.html'
},
{
text: 'Getting Started',
link: '/getting-started.html'
text: 'Installation',
link: '/installation.html'
},
{
text: 'Contribution',
Expand Down
45 changes: 0 additions & 45 deletions packages/docs/getting-started.md

This file was deleted.

48 changes: 48 additions & 0 deletions packages/docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Installation

Install `vue-final-modal` with your favorite package manager:

```bash
pnpm add vue-final-modal@next
# or with yarn
yarn add vue-final-modal@next
# or with npm
npm install vue-final-modal@next
```

:::tip
`vue-final-modal@next` install Vue Final Modal v3 for Vue 3. If your app is using Vue 2, you need to install Vue Final Modal v2: `vue-final-modal@latest`.
:::

## Usage

Here we show the simplest way to use Vue Final Modal:

```vue
<template>
<button @click="showModal = true">
show modal
</button>
<VueFinalModal v-model="showModal">
Modal Content!
</VueFinalModal>
</template>
<script>
import { VueFinalModal } from 'vue-final-modal'
export default {
components: {
VueFinalModal,
},
setup() {
const showModal = ref(false)
return { showModal }
},
}
</script>
```

There are many more features and use cases for Vue Final Modal. Be sure to browse through all the docs!

0 comments on commit 7cd67f0

Please sign in to comment.