diff --git a/docs/src/.vuepress/config.js b/docs/src/.vuepress/config.js index cf99388..c0775a9 100755 --- a/docs/src/.vuepress/config.js +++ b/docs/src/.vuepress/config.js @@ -43,13 +43,13 @@ module.exports = { } ], sidebar: { - '/guide/': [ + '/docs/': [ { - title: 'Guide', + title: 'Getting started', collapsable: false, children: [ '', - 'using-vue', + 'getting-started', ] } ], diff --git a/docs/src/config/README.md b/docs/src/config/README.md deleted file mode 100755 index 63a04b9..0000000 --- a/docs/src/config/README.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -sidebar: auto ---- - -# Config - -## foo - -- Type: `string` -- Default: `/` - -## bar - -- Type: `string` -- Default: `/` diff --git a/docs/src/docs/README.md b/docs/src/docs/README.md new file mode 100644 index 0000000..604b485 --- /dev/null +++ b/docs/src/docs/README.md @@ -0,0 +1,10 @@ +# Introduction + +`@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 diff --git a/docs/src/docs/getting-started.md b/docs/src/docs/getting-started.md new file mode 100755 index 0000000..780e29a --- /dev/null +++ b/docs/src/docs/getting-started.md @@ -0,0 +1,31 @@ +# Install and configure + +## 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') + +``` diff --git a/docs/src/docs/introduction.md b/docs/src/docs/introduction.md new file mode 100755 index 0000000..604b485 --- /dev/null +++ b/docs/src/docs/introduction.md @@ -0,0 +1,10 @@ +# Introduction + +`@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 diff --git a/docs/src/guide/README.md b/docs/src/guide/README.md deleted file mode 100755 index fc82aec..0000000 --- a/docs/src/guide/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Introduction - -VuePress is composed of two parts: a [minimalistic static site generator](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/core) with a Vue-powered [theming system](https://v1.vuepress.vuejs.org/theme/) and [Plugin API](https://v1.vuepress.vuejs.org/plugin/), and a [default theme](https://v1.vuepress.vuejs.org/theme/default-theme-config.html) optimized for writing technical documentation. It was created to support the documentation needs of Vue's own sub projects. - -Each page generated by VuePress has its own pre-rendered static HTML, providing great loading performance and is SEO-friendly. Once the page is loaded, however, Vue takes over the static content and turns it into a full Single-Page Application (SPA). Additional pages are fetched on demand as the user navigates around the site. diff --git a/docs/src/guide/using-vue.md b/docs/src/guide/using-vue.md deleted file mode 100755 index 71ac45b..0000000 --- a/docs/src/guide/using-vue.md +++ /dev/null @@ -1,9 +0,0 @@ -# Using Vue in Markdown - -## Browser API Access Restrictions - -Because VuePress applications are server-rendered in Node.js when generating static builds, any Vue usage must conform to the [universal code requirements](https://ssr.vuejs.org/en/universal.html). In short, make sure to only access Browser / DOM APIs in `beforeMount` or `mounted` hooks. - -If you are using or demoing components that are not SSR friendly (for example containing custom directives), you can wrap them inside the built-in `` component: - -## diff --git a/docs/src/index.md b/docs/src/index.md index ea70ed7..7e7d27b 100755 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -3,7 +3,7 @@ home: true heroImage: https://v1.vuepress.vuejs.org/hero.png tagline: Google maps components for Vue.js actionText: Quick Start → -actionLink: /guide/ +actionLink: /docs/ features: - title: Written with Vue.js details: This plugin makes strong use of Vue.js Composition api and is written from ground up for Vue.js 3 diff --git a/readme.md b/readme.md index f3f069e..23ad60c 100644 --- a/readme.md +++ b/readme.md @@ -33,10 +33,6 @@ const app = createApp(App); app.use(googleMap, googleMapOption) app.mount('#app') -``` -You can also install via Yarn -``` -yarn add @fawmi/vue-google-maps ``` ## Documentation