Skip to content

A modern and feature-rich Markdown editor and previewer built with React and Vite. Features real-time preview, dark/light themes, auto-save, file import/export, and multiple preview styles.

License

Notifications You must be signed in to change notification settings

melihcanndemir/markdown-previewer

Repository files navigation

📝 Markdown Previewer

Netlify Status PWA Ready Accessibility Score License: MIT

A sleek and modern markdown editor and previewer built with React + Vite ⚡

React Vite TailwindCSS

📸 Screenshots

🌞 Light Mode

Light Mode

🌚 Dark Mode

Dark Mode

✨ Features

  • 🌓 Dark/Light mode with smooth transitions
  • 💾 Real-time auto-save
  • 📱 Fully responsive design for all devices
  • 🚀 Live markdown preview
  • 🎨 Multiple preview styles (Default, GitHub, Elegant)
  • 📋 Import/Export markdown files
  • ⚡ Lightning-fast performance with Vite
  • 🎯 Customizable settings
  • 📊 Optional line numbers
  • 🔄 Auto-save functionality
  • 📱 PWA support for native app experience
  • ♿ Full accessibility support with ARIA labels
  • 🔌 Offline functionality
  • 📲 Install on any device
  • 🎨 Adaptive interface

🚀 Live Demo

Try it out: WebMarkdown

🛠️ Tech Stack

  • Frontend Framework: React 18.3
  • Build Tool: Vite 6.0
  • Styling: Tailwind CSS 3.4
  • PWA: Vite PWA Plugin
  • Key Dependencies:
    • 🎨 @heroicons/react
    • 📝 react-markdown
    • ✨ remark-gfm
    • 🎯 PropTypes
    • 📱 vite-plugin-pwa

💻 Local Development

  1. Clone the repository:
git clone https://github.com/melihcanndemir/markdown-previewer.git
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev
  1. Build for production:
npm run build

🎯 Usage

Editor Features

  • Write markdown in the left panel
  • See instant preview in the right panel
  • Toggle dark/light mode with the theme button
  • Use the settings button to customize your experience

PWA Features

  • Install as a native app
  • Work offline
  • Fast loading times
  • Home screen installation
  • App-like experience

Accessibility Features

  • Full keyboard navigation
  • ARIA labels for all interactive elements
  • High contrast mode support
  • Screen reader friendly
  • Focus management

Import/Export

  • Click Import to load .md files
  • Click Export to save your work
  • Supports local storage auto-save

Settings

  • Adjust font size
  • Choose preview style
  • Toggle line numbers
  • Enable/Disable auto-save
  • Customize PWA behavior

📱 Responsive Design

Optimized for all devices:

  • 💻 Desktop
  • 📱 Tablets (including iPad Air)
  • 📱 Foldable devices (including Zenbook Fold)
  • 📱 Mobile phones

🤝 Contributing

Contributions are welcome! Feel free to:

  1. Fork the repository
  2. Create your feature branch
  3. Submit a Pull Request

📜 License

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

🙏 Credits

👨‍💻 Author


Made with ❤️ by Melih Can Demir

About

A modern and feature-rich Markdown editor and previewer built with React and Vite. Features real-time preview, dark/light themes, auto-save, file import/export, and multiple preview styles.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages