vue-mapbox
Version:
> Combine powers of [Vue.js](https://vuejs.org/) and [Mapbox Gl JS](https://mapbox.com/mapbox-gl-js)
63 lines (38 loc) • 1.29 kB
Markdown
# VueMapbox [](https://travis-ci.org/soal/vue-mapbox) [](https://badge.fury.io/js/vue-mapbox)
> Combine powers of [Vue.js](https://vuejs.org/) and [Mapbox Gl JS](https://mapbox.com/mapbox-gl-js)
Vue-mapbox is wrapper around Mapbox GL JS library that provides vueish-way to interact with the map.
[Description and documentation](https://soal.github.io/vue-mapbox)
## Size
~ 15 kB minified and gzipped
## Browser compatibility
_Coming soon_
## Development
```sh
git clone git@github.com:soal/vue-mapbox.git
cd vue-mapbox
npm install
```
Running in dev mode:
```sh
npm run serve
```
Build for production:
```sh
npm run build
```
### Documentation
Documentation use [VuePress 1.0](https://vuepress.vuejs.org).
Documentations source palced in `docs_source` directory and builds into `docs` directory
Start documentation site in development mode:
```sh
npm run docs:serve
```
Build documentation:
```sh
npm run docs:build
```
Inspired by KoRiGaN's [Vue2Leaflet](https://github.com/KoRiGaN/Vue2Leaflet).
## License
MIT
## Contributing
Just fork `development` branch and create PR when your work is done. Please ensure you are not added dist files.