Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 1.95 KB

README.md

File metadata and controls

40 lines (23 loc) · 1.95 KB

Thambnail

Markdown Editor

This Markdown Editor is a simple web-based tool designed to provide an intuitive interface for writing and previewing Markdown documents. Markdown is a lightweight markup language with plain-text formatting syntax, often used to format readme files, documentation, and other types of text-based content.

Features

  • Syntax Highlighting: Utilizes CodeMirror to provide syntax highlighting for Markdown text, making it easier to read and edit.
  • Live Preview: Instantly see the rendered HTML output of your Markdown text as you type.
  • Download Markdown File: Allows users to download their Markdown document as a file, with the option to specify the filename.

Usage

  1. Writing Markdown: Simply start typing in the editor section. The Markdown syntax will be highlighted for better readability.
  2. Preview: As you type, the preview section will display the rendered HTML output of your Markdown text in real-time.
  3. Download Markdown: To download your Markdown document, enter a filename in the input field under "Download Markdown" and click the "Download" button.

Contributor Guide

We welcome contributions from the community to improve the Markdown Editor. If you'd like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix: git checkout -b feature-name.
  3. Make your changes and commit them: git commit -m 'Add some feature'.
  4. Push to the branch: git push origin feature-name.
  5. Submit a pull request detailing your changes.

Credits

This Markdown Editor was created by Rakesh Kanna. You can find the source code and contribute to the project on GitHub.

PROJECT UNDER MIT LICENSE