1.0.20 • Published 11 months ago

sampaadak v1.0.20

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

Sampaadak ( सम्पादक )

Sampaadak is a Nepali word for Editor, and that's exactly what this tool is designed to do. Sampaadak is a powerful, flexible, and user-friendly rich text editor that helps you create content effortlessly. Built on top of Tiptap, it supports various text formatting options, media integration, and more, making it an ideal choice for content creators, developers, and anyone needing an intuitive editor.

Features

  • Rich Text Formatting: Bold, italic, underline, strike-through, code, blockquote, bullet lists, and ordered lists.
  • Media Integration: Easily embed YouTube videos and images.
  • Resizing and Alignment: Resize and align images within your content.
  • Base64 Image Embedding: Upload and embed images as base64 URLs.

Installation

To get started with Sampaadak, follow these steps:

Install via NPM

You can install Sampaadak using npm:

npm install sampaadak

Sure, here's an improved version of the instructions for running a demo of the editor:


Running a Demo for Sampaadak Editor

To see Sampaadak in action, you can run a demo included in the project. Follow these steps:

  1. In the root directory of the project, run the following command to start the demo:
npm run start

This command will bundle the package and place it inside the dist folder. Also, it will create an index.html file that will include this recently created bundle file.

  1. Open the index.html file in your web browser to interact with the Sampaadak editor and explore its features.

Note: It uses http-server package to launch the webpage.


Contributing

We welcome contributions! If you have suggestions, improvements, or bug fixes, please create a pull request or submit an issue.

License

Sampaadak is open-source and available under the MIT License.