Commit 60e67712 authored by Fawad Mirzad's avatar Fawad Mirzad
Browse files

Update the docs

parent 2b9c93da

docs/src/.vuepress/config.js

+35 −16
Original line number Diff line number Diff line
@@ -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/': [

    sidebar: [

      {

        title: 'Getting started',

        path: '/docs/',

        sidebarDepth: 2,

        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',

        ]

      }

      ],

    }

    ]

  },



  /**

docs/src/advanced/README.md

0 → 100644
+10 −0
Original line number Diff line number Diff line 
# 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
 
 No newline at end of file

docs/src/advanced/introduction.md

0 → 100755
+10 −0
Original line number Diff line number Diff line 
# 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
 
 No newline at end of file

docs/src/advanced/map.md

0 → 100755
+31 −0
Original line number Diff line number Diff line 
# 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')



```

docs/src/components/README.md

0 → 100644
+10 −0
Original line number Diff line number Diff line 
# 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
 
 No newline at end of file