Skip to content

Your go-to Markdown editor in React, empowering text formatting, image embedding, and more with a sleek user interface. ✍️✨

Notifications You must be signed in to change notification settings

yatharthbhatia/MarkEase

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mark-Ease Markdown Editor 🚀

Mark-Ease is a simple Markdown editor built using React. With Mark-Ease, you can format text, create links, insert images, and more, all using Markdown syntax. ✨

Features 🌟

  • Text Formatting: Apply various formatting styles such as bold, italic, code, and strikethrough to your text. This helps in emphasizing and structuring your content effectively.

  • Headings: Organize your content using different levels of headings. Mark-Ease supports headings from H1 to H6, allowing you to create clear hierarchies and sections in your Markdown documents.

  • Lists: Create bulleted and numbered lists with sub-bullets. Lists are essential for creating easy-to-read content and listing items or steps.

  • Code Blocks: Include code blocks with syntax highlighting for better readability. Mark-Ease uses Syntax Highlighter to provide syntax highlighting for various programming languages.

  • Images: Easily insert images using Markdown syntax. This feature allows you to include images in your Markdown documents and enhance visual representation.

  • Links: Create hyperlinks effortlessly. Insert URLs with link text to navigate users to external or internal resources.

Getting Started 🎉

To get started with Mark-Ease Markdown Editor, follow these simple steps:

  1. Clone the Repository: First, clone the Mark-Ease repository to your local machine using Git. Open your terminal and run the following command:

    git clone https://github.com/YatharthBhatia/mark-ease.git
    
  2. Navigate to the Project Directory: Once the repository is cloned, navigate to the project directory using the cd command:

    cd mark-ease
    
  3. Install Dependencies: Before running the application, install the required dependencies using npm (Node Package Manager). Run the following command:

    npm install
    
  4. Start the Development Server: After installing the dependencies, you can start the development server to run Mark-Ease locally. Use the following command:

    npm start
    
    

Usage 🚀

  1. Open the Mark-Ease Markdown editor.
  2. Type or paste your Markdown content in the editor.
  3. Use the toolbar to apply formatting, create lists, insert images, and links.
  4. Preview your Markdown content in real-time.

Technologies Used 🛠️

  • React: A JavaScript library for building user interfaces.
  • React Markdown: A component for rendering Markdown content in React applications.
  • Syntax Highlighter: A library for syntax highlighting code blocks in Markdown.
  • Tailwind CSS: A utility-first CSS framework for building custom designs.

Preview 🌟

Mark-Ease.mp4

About

Your go-to Markdown editor in React, empowering text formatting, image embedding, and more with a sleek user interface. ✍️✨

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published