Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spotonlive/vue-highlighter
Simple element highlighter
https://github.com/spotonlive/vue-highlighter
Last synced: about 1 month ago
JSON representation
Simple element highlighter
- Host: GitHub
- URL: https://github.com/spotonlive/vue-highlighter
- Owner: spotonlive
- License: mit
- Created: 2017-07-05T10:22:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-07-11T10:23:00.000Z (over 7 years ago)
- Last Synced: 2024-11-09T08:49:01.160Z (about 2 months ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# VueHighlighter
[](https://www.npmjs.com/package/@spotonmarketing/vue-highlighter) [](https://vuejs.org/)
> A Vue.js Plugin
## Installation
```bash
npm install --save @spotonmarketing/vue-highlighter
```
## Usage
### Bundler (Webpack, Rollup)
```js
import Vue from 'vue'
import VueHighlighter from '@spotonmarketing/vue-highlighter'
// You need a specific loader for CSS files like https://github.com/webpack/css-loader
import '@spotonmarketing/vue-highlighter/dist/@spotonmarketing/vue-highlighter.css'
Vue.use(VueHighlighter)
```
### Browser
```html
```
## Development
### Launch visual tests
```bash
npm run dev
```
### Launch Karma with coverage
```bash
npm run dev:coverage
```
### Build
Bundle the js and css of to the `dist` folder:
```bash
npm run build
```
## Publishing
The `prepublish` hook will ensure dist files are created before publishing. This
way you don't need to commit them in your repository.
```bash
# Bump the version first
# It'll also commit it and create a tag
npm version
# Push the bumped package and tags
git push --follow-tags
# Ship it 🚀
npm publish
```
## License
[MIT](http://opensource.org/licenses/MIT)