Update the docs
This commit is contained in:
@@ -34,26 +34,45 @@ module.exports = {
|
|||||||
lastUpdated: false,
|
lastUpdated: false,
|
||||||
nav: [
|
nav: [
|
||||||
{
|
{
|
||||||
text: 'Guide',
|
text: 'Docs',
|
||||||
link: '/guide/',
|
link: '/docs/',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
text: 'Config',
|
text: 'Github',
|
||||||
link: '/config/'
|
link: 'https://github.com/fawmi/vue-google-maps.git'
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
sidebar: {
|
sidebar: [
|
||||||
'/docs/': [
|
{
|
||||||
{
|
title: 'Getting started',
|
||||||
title: 'Getting started',
|
path: '/docs/',
|
||||||
collapsable: false,
|
sidebarDepth: 2,
|
||||||
children: [
|
collapsable: false,
|
||||||
'',
|
children: [
|
||||||
'getting-started',
|
'/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',
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
10
docs/src/advanced/README.md
Normal file
10
docs/src/advanced/README.md
Normal 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
|
||||||
10
docs/src/advanced/introduction.md
Executable file
10
docs/src/advanced/introduction.md
Executable 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
31
docs/src/advanced/map.md
Executable 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')
|
||||||
|
|
||||||
|
```
|
||||||
10
docs/src/components/README.md
Normal file
10
docs/src/components/README.md
Normal 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
|
||||||
10
docs/src/components/introduction.md
Executable file
10
docs/src/components/introduction.md
Executable 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
31
docs/src/components/map.md
Executable 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')
|
||||||
|
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user