Skip to content

A powerful, modern, and feature-rich Markdown editor built with React, TypeScript, and Tailwind CSS. Experience seamless writing with real-time preview, syntax highlighting, and advanced formatting tools.

License

Notifications You must be signed in to change notification settings

denisetiya/markdown-editor

Repository files navigation

Markdown Editor 🚀

A powerful, modern, and feature-rich Markdown editor built with React, TypeScript, and Tailwind CSS. Experience seamless writing with real-time preview, syntax highlighting, and advanced formatting tools.

Markdown Editor Preview

🌟 Features

  • Real-time Preview - See your changes as you type
  • Syntax Highlighting - Beautiful code blocks with language support
  • Mermaid Diagrams - Create flowcharts, sequence diagrams, and more
  • Emoji Support - Add emojis with the built-in picker
  • Table Generator - Easily create and customize tables
  • Folder Structure Generator - Visualize directory structures
  • Code Generator - Generate code snippets in multiple languages
  • Auto-save - Never lose your work with automatic saving
  • Export Options - Download your documents as Markdown files
  • Fullscreen Mode - Focus on writing with distraction-free mode
  • Responsive Design - Works beautifully on all devices
  • Dark Theme - Easy on the eyes dark interface

🚀 Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn

Installation

# Clone the repository
git clone https://github.com/denisetiya/markdown-editor.git

# Navigate to the project directory
cd markdown-editor

# Install dependencies
npm install

# Start the development server
npm run dev

Build for Production

# Build the project
npm run build

🛠️ Technologies Used

  • React 19 - Modern UI library
  • TypeScript - Type safety and better development experience
  • Tailwind CSS - Utility-first CSS framework
  • Vite - Lightning fast build tool
  • Lucide React - Beautiful icons
  • Mermaid - Diagram generation
  • React Markdown - Markdown rendering

📖 Usage

  1. Writing - Use the left panel to write your Markdown
  2. Preview - See the rendered output in the right panel
  3. Formatting - Use the toolbar for quick formatting options
  4. Special Features:
    • Insert tables with the table generator
    • Add emojis with the emoji picker
    • Create diagrams with Mermaid syntax
    • Generate folder structures
    • Create code snippets in multiple languages

🎨 UI Components

  • Header - Project title and sidebar toggle
  • Toolbar - Formatting options and actions
  • Editor - Main writing area with syntax highlighting
  • Preview - Real-time rendered output
  • Sidebar - Additional tools and settings
  • Status Bar - Document statistics and information

🔧 Customization

Auto-save

Enable or disable auto-save in the sidebar settings. Your content is automatically saved to browser's local storage.

Themes

Dark theme is enabled by default with a sleek gradient design.

🤝 Support

If you find this project useful, consider supporting the development:

  • Saweria: Donate via Saweria
  • GitHub: Star this repository
  • Share: Spread the word about this tool

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

👤 Author

Deni Setiya

🙏 Acknowledgements


If you like this project, please consider giving it a star on GitHub!

About

A powerful, modern, and feature-rich Markdown editor built with React, TypeScript, and Tailwind CSS. Experience seamless writing with real-time preview, syntax highlighting, and advanced formatting tools.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published