Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janwirth/vue-medium-editor
✍️ A MediumEditor component for Vue 2. Demo:
https://github.com/janwirth/vue-medium-editor
medium-editor vue
Last synced: 4 days ago
JSON representation
✍️ A MediumEditor component for Vue 2. Demo:
- Host: GitHub
- URL: https://github.com/janwirth/vue-medium-editor
- Owner: janwirth
- License: mit
- Created: 2016-10-05T09:41:06.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-06-09T17:06:49.000Z (over 4 years ago)
- Last Synced: 2024-04-14T21:08:24.401Z (9 months ago)
- Topics: medium-editor, vue
- Language: JavaScript
- Homepage: https://franzskuffka.github.io/vue-medium-editor/
- Size: 489 KB
- Stars: 406
- Watchers: 9
- Forks: 64
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# vue2-medium-editor
A [medium-editor](https://github.com/yabwe/medium-editor) component for Vue2. For Vue1 checkout branch 1.0.
[](https://github.com/feross/standard)
## Installation
```bash
#bash
npm i --save vue2-medium-editor
```
## Usage
```javascript
//app.js
import editor from 'vue2-medium-editor'
import Vue from 'vue'
new Vue {
...
components: {
'medium-editor': editor
}
}
```
```vue
```
> Full usage example at [github.com/FranzSkuffka/vue-medium-editor/tree/gh-pages](https://github.com/FranzSkuffka/vue-medium-editor/tree/gh-pages)
A list of available options can be found in the [documentation of MediumEditor](https://github.com/yabwe/medium-editor#core-options).
Optionally you may use the standalone builds from `dist` which have medium-editor.js included.
> **Make sure you include the required [CSS](https://github.com/yabwe/medium-editor/tree/master/dist/css).**
### Custom buttons and extensions
To create extensions for the MediumEditor you will need the original MediumEditor object, which
you can get like this:
```javascript
var HighlightButton = VueMediumEditor.MediumEditor.Extension.extend({
// ...
});
```
See [Extensions](https://github.com/yabwe/medium-editor/tree/master/src/js/extensions)
section of the MediumEditor's wiki for details.
## Bundling & Minification
To generate the standalone bundle
```bash
npm i --save-dev
npm run prepublish
```
## Known Issues
If you encounter issues with the link button and the events it emits, please refer to https://github.com/yabwe/medium-editor/issues/1153.
## Contributors
- [gcoda](https://github.com/gcoda)
- [seguer](https://github.com/seguer)
- [DannyFeliz](https://github.com/DannyFeliz)
- [okneloper](https://github.com/okneloper)
- [dmattia](https://github.com/dmattia)
Anyone else who opened an Issue or PR!
**Thank you!** :tada: