Update the docs

This commit is contained in:
Fawad Mirzad
2020-10-19 15:20:22 +02:00
parent 2b9c93da8a
commit 60e6771231
7 changed files with 137 additions and 16 deletions

View File

@@ -34,26 +34,45 @@ module.exports = {
lastUpdated: false,
nav: [
{
text: 'Guide',
link: '/guide/',
text: 'Docs',
link: '/docs/',
},
{
text: 'Config',
link: '/config/'
text: 'Github',
link: 'https://github.com/fawmi/vue-google-maps.git'
}
],
sidebar: {
'/docs/': [
{
title: 'Getting started',
collapsable: false,
children: [
'',
'getting-started',
]
}
],
}
sidebar: [
{
title: 'Getting started',
path: '/docs/',
sidebarDepth: 2,
collapsable: false,
children: [
'/docs/introduction',
'/docs/getting-started',
]
},
{
title: 'Components',
collapsable: false,
path: '/components/',
sidebarDepth: 2,
children: [
'/components/introduction',
'/components/map',
]
},
{
title: 'Advanced',
collapsable: false,
path: '/advanced/',
sidebarDepth: 2,
children: [
'/advanced/introduction',
]
}
]
},
/**

View File

@@ -0,0 +1,10 @@
# List
`@fawmi/vue-google-maps` provides a set of Vue.js 3 components wrapping the Google Maps API v3.
Currently `Map`, `Marker`, `InfoWindow`, `Polygon` and `Rectangle` are supported.
Other components are still under development.
Checkout getting started to read, how to install and use vue-google-maps

View File

@@ -0,0 +1,10 @@
# Advanced
`@fawmi/vue-google-maps` provides a set of Vue.js 3 components wrapping the Google Maps API v3.
Currently `Map`, `Marker`, `InfoWindow`, `Polygon` and `Rectangle` are supported.
Other components are still under development.
Checkout getting started to read, how to install and use vue-google-maps

31
docs/src/advanced/map.md Executable file
View File

@@ -0,0 +1,31 @@
# Map
## Install
to install it via NPM
```bash
npm install -S @fawmi/vue-google-maps
```
You can also install via Yarn
```bash
yarn add @fawmi/vue-google-maps
```
## Example
Here is a basic example
```javascript
import { createApp } from 'vue'
import googleMap from '@fawmi/vue-google-maps'
import App from './App.vue';
const googleMapOption = {
apiKey: 'here_comes_your_api_key',
}
const app = createApp(App);
app.use(googleMap, googleMapOption)
app.mount('#app')
```

View File

@@ -0,0 +1,10 @@
# List
`@fawmi/vue-google-maps` provides a set of Vue.js 3 components wrapping the Google Maps API v3.
Currently `Map`, `Marker`, `InfoWindow`, `Polygon` and `Rectangle` are supported.
Other components are still under development.
Checkout getting started to read, how to install and use vue-google-maps

View File

@@ -0,0 +1,10 @@
# Component list
`@fawmi/vue-google-maps` provides a set of Vue.js 3 components wrapping the Google Maps API v3.
Currently `Map`, `Marker`, `InfoWindow`, `Polygon` and `Rectangle` are supported.
Other components are still under development.
Checkout getting started to read, how to install and use vue-google-maps

31
docs/src/components/map.md Executable file
View File

@@ -0,0 +1,31 @@
# Map
## Install
to install it via NPM
```bash
npm install -S @fawmi/vue-google-maps
```
You can also install via Yarn
```bash
yarn add @fawmi/vue-google-maps
```
## Example
Here is a basic example
```javascript
import { createApp } from 'vue'
import googleMap from '@fawmi/vue-google-maps'
import App from './App.vue';
const googleMapOption = {
apiKey: 'here_comes_your_api_key',
}
const app = createApp(App);
app.use(googleMap, googleMapOption)
app.mount('#app')
```