markdown-text-editor v0.1.5

MarkdownEditor Plugin Documentation

Transform textarea into powerful Markdown editor, and get/set value as standard HTML method.

DEMO

Welcome to the documentation for the MarkdownEditor Plugin – an open source project offering the best, simple, embeddable JavaScript Markdown editor plugin or library. This powerful tool provides real-time preview, syntax highlighting, and easy integration into your projects. Whether you’re building a blog, note-taking app, or any content-rich website, this plugin delivers a robust and customizable markdown editing experience.

• ✅ Actively Maintenaning: The plugin receives regular updates to stay up to date.
• ✅ User-Friendly: It offers a WYSIWYG-style interface, making it great for non-technical users.
• ✅ Simple Markdown Get/Set: No complicated techniques are required to get and set the markdown content. You can use the value or name attribute to get and set markdown content.
• ✅ Tailwind CSS Support: Built with TailwindCSS, and it will work with both Tailwind CSS and non-Tailwind CSS projects.
• ✅ Responsive: The editor is fully responsive, providing a seamless experience across all screen sizes.
• ✅ RTL Support: By default Right-to-Left (RTL) text is supported, making it ideal for languages like Arabic, Urdu, and Farsi.
• ✅ Module Support: Supports ESM, UMD, and CommonJS modules, making it easy to integrate with different module systems.
• ✅ Live Preview Mode: Watch your markdown content render while you type, providing a real-time preview of formatting, links, images, and more.
• ✅ Automatic Dark Mode Support: The editor follows your system's or website's dark mode settings, giving a seamless experience.

Table of Contents

• Overview
• Installation
• Usage
• Markdown Content Retrieval
  • JavaScript Value Retrieval
  • HTML Template Form Submission
• Set Markdown Content to Editor
• Configuration Options
• Toolbar Customization
• Example Implementations
• Contribution Guidelines
• License

Overview

The MarkdownEditor Plugin is designed to be the best, simple, and embeddable JavaScript markdown editor plugin available. It is an open source project that boasts:

• Real-time Preview: See your markdown rendered instantly as you type.
• Syntax Highlighting: Enhanced readability with clear code and markdown formatting.
• Easy Integration: Seamlessly integrate into any web project with minimal setup.
• Customizable Toolbar: Dynamically configure and reorder toolbar options like bold, italic, and more.

Built with Tailwind CSS for modern styling, this plugin is perfect for developers seeking a lightweight yet feature-rich markdown editor.

Installation

Integrating the MarkdownEditor Plugin into your project is straightforward. You can install it using NPM, import the JavaScript file directly, or use a CDN for rapid deployment.

Install via NPM

For projects utilizing bundling tools like Webpack, run:

npm install markdown-text-editor

Usage

After installation, import the MarkdownEditor class from the package:

import MarkdownEditor from "markdown-text-editor";

Basic Initialization

To get started, include a <textarea> element in your HTML and initialize the editor by targeting its container:

HTML

<textarea class="editor-container"></textarea>

JavaScript

const editor = new MarkdownEditor('.editor-container', {
    placeholder: 'Write your markdown...',
    toolbar: ['heading', 'bold', 'italic', 'strikethrough', 'ul', 'ol', 'checklist', 'blockquote', 'link', 'preview'],
});

CSS Setup

Using TailwindCSS

If you’re leveraging TailwindCSS, add the following configuration to your tailwind.config.js:

// tailwind.config.js
module.exports = {
  content: [
    'node_modules/markdown-text-editor/**/*.js',
    // Add your project paths here
  ],
};

Without TailwindCSS

For projects not using TailwindCSS, simply import the CSS file directly:

import 'markdown-text-editor/dist/markdown-text-editor.css';

Using a CDN

Alternatively, include the following CDN links in your HTML:

JavaScript:

<script src="https://cdn.jsdelivr.net/npm/markdown-text-editor/dist/markdown-text-editor.js"></script>

CSS:

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/markdown-text-editor/dist/markdown-text-editor.css">

Markdown Content Retrieval

JavaScript Value Retrieval

In this method, you can access the markdown content entered into the editor directly using JavaScript. This is helpful when you want to dynamically retrieve the value and process it in your application (e.g., displaying it elsewhere or sending it via AJAX).

HTML

<form>
  <textarea class="editor-container h-48" rows="5"></textarea>
  <button type="button" id="submit-btn">Submit</button>
  <div class="output"></div>
</form>

JavaScript

const editor = new MarkdownEditor('.editor-container', {
    placeholder: 'Start writing...',
    toolbar: ['bold', 'italic', 'preview'],
});

document.getElementById('submit-btn').addEventListener('click', function() {
    const markdownValue = document.querySelector('.editor-container').value;
    console.log(markdownValue);
    document.querySelector('.output').innerHTML = `<pre>${markdownValue}</pre>`;
});

HTML Template Form Submission

If you prefer a traditional form submission approach (for example, in server-side applications like Django), you can integrate the markdown editor into a form that submits the value to the server for processing.

HTML (Form Submission)

<form method="POST" action="/your-server-endpoint">
    <textarea class="editor-container h-48" rows="5" name="markdown"></textarea>
    <button type="submit">Submit</button>
</form>

you can retrieve the value from a traditional <textarea> in a form submission without any custom element. When the form is submitted, the content inside the <textarea> is automatically included as part of the form data, using the name attribute of the <textarea>.

JavaScript (MarkdownEditor Initialization)

const editor = new MarkdownEditor('.editor-container', {
    placeholder: 'Write your markdown...',
    toolbar: ['preview', 'bold', 'italic'],
});

Set Markdown Content to Editor

<form method="POST" action="/your-server-endpoint">
    <textarea class="editor-container h-48" rows="5" name="markdown">Add your markdown content here</textarea>
    <button type="submit">Submit</button>
</form>

Configuration Options

Customize your Markdown editor by passing an options object during initialization. Below are some key configuration options:

Toolbar Customization

Tailor the toolbar to suit your needs by choosing which formatting options to include. The MarkdownEditor Plugin supports several tools, including:

• bold: Enables bold text formatting.
• italic: Enables italic text formatting.
• strikethrough: Allows text to be struck through.
• ol: (Ordered List): Converts text into a numbered list format.
• ul: (Unordered List): Converts text into a bullet point list. checklist: Adds checkboxes to your text, making it great for tasks, to-do lists, or tracking completion status.
• preview: Toggles the real-time markdown preview.

Example:

const editor = new MarkdownEditor('.editor-container', {
    placeholder: 'Start writing...',
    toolbar: ['bold', 'italic', 'strikethrough', 'preview'],
});

Example Implementations

Full HTML Example

Below is a complete HTML example demonstrating how to integrate the MarkdownEditor Plugin into your project:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Markdown Editor Example</title>
  <link rel="stylesheet" href="dist/markdown-editor-plugin.css">
</head>
<body>
  <textarea class="editor-container h-56" rows="6"></textarea>

  <script src="dist/markdown-editor-plugin.js"></script>
  <script>
    const editor = new MarkdownEditor('.editor-container', {
      placeholder: 'Type your markdown...',
      toolbar: ['preview', 'bold', 'italic']
    });
  </script>
</body>
</html>

Webpack Integration Example

For projects using Webpack, import and initialize the editor as follows:

import MarkdownEditor from 'markdown-text-editor';

const editor = new MarkdownEditor('.editor-container', {
    placeholder: 'Write markdown...',
    toolbar: ['preview', 'bold', 'italic'],
});

Customizing Styles with TailwindCSS

Customize the appearance of the editor using Tailwind utility classes. The plugin’s default styling can be easily overridden in your custom Tailwind configuration.

Contribute

Contributions to this open source project are highly encouraged! If you have bug fixes, feature enhancements, or new ideas, please consider opening an issue or submitting a pull request. Your help will ensure that this best, simple, embeddable JavaScript markdown editor plugin continues to evolve and serve the community with real-time preview and syntax highlighting capabilities.

License

This project is released under the MIT License.

Thank you for choosing the MarkdownEditor Plugin – your reliable, feature-rich solution for seamless markdown editing and content creation with easy integration. Happy coding!