on-codemerge
TypeScript icon, indicating that this package has built-in type declarations

0.8.1 • Public • Published

npm version npm downloads NPM license npm type definitions GitHub Repo stars

on-codemerge

zero dependencies editor

Docs

logo

logo

logo

Description

A WYSIWYG editor for on-codemerge is a user-friendly interface that allows users to edit and view their code in real time, exactly as it will appear in the final product. This intuitive tool for developers of all skill levels.

Installation

To use the editor, include it in your project by importing the main EditorCore class and any required plugins.

import { EditorCore } from 'on-codemerge';
import BoldButtonPlugin from 'on-codemerge/boldbuttonplugin';
// Import other plugins as needed

Setup

Initialize the editor by creating an instance of EditorCore and passing the target DOM element where the editor should be rendered.

const targetElement = document.getElementById('editor');
const editor = new EditorCore(targetElement);

// Register plugins
editor.registerModule(new BoldButtonPlugin());
// Register other plugins in a similar manner

// To start the editor
editor.init();

Using Plugins

Plugins can be added to enhance the functionality of the editor. Here's an example of how to add a bold button plugin.

import BoldButtonPlugin from 'path/to/boldbuttonplugin';

// After initializing the editor
editor.registerModule(new BoldButtonPlugin());

Contribution

Contributions to the editor are welcome. Please ensure that custom plugins and features adhere to the project's architecture and coding standards.


For more detailed documentation, please refer to the individual plugin files and the source code of EditorCore.

Package Sidebar

Install

npm i on-codemerge

Weekly Downloads

1

Version

0.8.1

License

MIT

Unpacked Size

15.5 MB

Total Files

234

Last publish

Collaborators

  • s00d