Skip to content

G4URAV001/markdown-editor

Repository files navigation

Markdown Editor

A modern, feature-rich markdown editor with live preview built with React, TypeScript, and Tailwind CSS.

Features

  • Live Preview: See your markdown rendered in real-time as you type
  • GitHub-Flavored Markdown: Full support for GFM features including tables, code blocks, and more
  • Responsive Design: Works seamlessly on desktop and mobile devices
  • Auto-Save: Your work is automatically saved to local storage
  • Clean Interface: Minimalist design focused on writing
  • Syntax Highlighting: Code editor with markdown syntax highlighting

Getting Started

Prerequisites

  • Node.js (version 16 or higher)
  • npm or yarn

Installation

  1. Clone or download this repository

  2. Install dependencies:

    npm install
  3. Start the development server:

    npm run dev
  4. Open your browser and navigate to http://localhost:5173

Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run preview - Preview production build
  • npm run lint - Run ESLint

Technologies Used

  • React - UI library
  • TypeScript - Type safety
  • Vite - Build tool and development server
  • Tailwind CSS - Styling
  • CodeMirror - Code editor
  • Marked - Markdown parser
  • Lucide React - Icons

License

This project is open source and available under the MIT License.

Releases

No releases published

Packages

No packages published