vue-novel
v0.0.18
Published
Inspired by Novel. This is AI powered Editor that you can integrate into any Vue-based web application
Downloads
25
Readme
Vue Novel
Introducing Vue Novel: Empower your Vue or Nuxt.js web applications with an AI-driven editor! This open-source plugin draws inspiration from Novel, delivering a rich array of features and functionalities to elevate your content creation and editing process.
Additionally, you can leverage our Nuxt.js example project as a solid foundation for your own endeavors. Elevate your content creation journey with Vue Novel!
Installation
To install Vue Novel, you can use npm:
npm install vue-novel
Usage
You can register the Novel plugin in your app's root
import { VueNovelPlugin } from 'vue-novel'
app.use(VueNovelPlugin)
Then, you can use the vue-novel
component in your template:
<template>
<div>
<vue-novel />
</div>
</template>
or you can import Vue Novel into your Vue components like this:
import 'vue-novel/style.css'
import { Editor } from 'vue-novel'
export default {
components: {
Editor
}
// ...
}
<template>
<div>
<Editor />
</div>
</template>
Features
Vue Novel offers the following features:
- WYSIWYG Editor: A user-friendly editor that allows you to create and edit content easily.
- Markdown Support: Support for writing content in Markdown format.
- Syntax Highlighting: Support for code hightlighting.
- AI: Completion: Support for Text completion
- Document Versioning: TBD.
- Export Options: TBD.
- Real-time collaboration: TBD
Contributing
Contributions to Vue Novel are welcome! If you have any ideas, bug reports, or feature requests, feel free to open an issue or submit a pull request on the GitHub repository.
License
Vue Novel is open-source software licensed under the MIT License.
Acknowledgements
Vue Novel is built on top of some amazing open-source projects and AI technologies. We would like to express our gratitude to the developers and contributors of these projects.
Contact
If you have any questions or need support, you can reach us through the following channels:
- Issues: If you encounter any bugs or have feature requests, please submit an issue on the GitHub repository.
- Email: You can also reach out to us via email at [email protected].
We appreciate your interest and contributions to Vue Novel. Happy writing and editing!