Update docs
This commit is contained in:
@@ -43,13 +43,13 @@ module.exports = {
|
||||
}
|
||||
],
|
||||
sidebar: {
|
||||
'/guide/': [
|
||||
'/docs/': [
|
||||
{
|
||||
title: 'Guide',
|
||||
title: 'Getting started',
|
||||
collapsable: false,
|
||||
children: [
|
||||
'',
|
||||
'using-vue',
|
||||
'getting-started',
|
||||
]
|
||||
}
|
||||
],
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar: auto
|
||||
---
|
||||
|
||||
# Config
|
||||
|
||||
## foo
|
||||
|
||||
- Type: `string`
|
||||
- Default: `/`
|
||||
|
||||
## bar
|
||||
|
||||
- Type: `string`
|
||||
- Default: `/`
|
||||
10
docs/src/docs/README.md
Normal file
10
docs/src/docs/README.md
Normal file
@@ -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
|
||||
31
docs/src/docs/getting-started.md
Executable file
31
docs/src/docs/getting-started.md
Executable file
@@ -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')
|
||||
|
||||
```
|
||||
10
docs/src/docs/introduction.md
Executable file
10
docs/src/docs/introduction.md
Executable file
@@ -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
|
||||
@@ -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.
|
||||
@@ -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 `<ClientOnly>` component:
|
||||
|
||||
##
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user