Thanks to visit codestin.com
Credit goes to github.com

Skip to content

azateser/md-preview-tool

Repository files navigation

Demo

📝 MD-Preview-Tool

A modern and user-friendly Markdown preview application

🔗 Live Demo

Next.js TypeScript React Tailwind CSS License

📸 Screenshots

Screenshot 1 Screenshot 2 Screenshot 3

✨ Features

  • 📱 Modern and responsive design
  • 🌙 Dark/Light theme support
  • ⚡️ Real-time preview
  • 🎨 Syntax highlighting
  • 📋 Drag & Drop file support
  • 💾 Auto-save functionality
  • 🤖 AI supported markdown generator
  • 📤 Export Markdown files
  • 🔍 Emoji and GFM (GitHub Flavored Markdown) support
  • 🎯 Customizable editor
  • 🚀 Fast and performant

🛠️ Tech Stack

🚀 Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn

Installation

# Clone the repository
git clone https://github.com/azateser/md-preview-tool.git

# Navigate to the project directory
cd md-preview-tool

# Install dependencies
npm install

# Start development server
npm run dev

Visit http://localhost:3000

📁 Project Structure

.
├── src/
│   ├── app/              # Page components
│   ├── components/       # UI components
│   ├── hooks/           # Custom React hooks
│   ├── lib/             # Helper functions
│   ├── store/           # Zustand store
│   ├── types/           # TypeScript types
│   └── utils/           # Utility functions
├── public/              # Static files
└── styles/             # Global styles

💻 Usage

  1. Write Markdown text in the left panel
  2. See real-time preview in the right panel
  3. Your files are automatically saved
  4. Export whenever you want

Markdown Features

  • Headers (# H1, ## H2, etc.)
  • Lists (ordered and unordered)
  • Links and Images
  • Code blocks (with syntax highlighting)
  • Tables
  • Emoji support
  • GitHub Flavored Markdown

🔧 Configuration

You can customize theme colors by editing tailwind.config.js:

module.exports = {
  theme: {
    extend: {
      colors: {
        primary: '#...',
        secondary: '#...',
      }
    }
  }
}

🤝 Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing)
  5. Open a Pull Request

📝 Roadmap

  • Multi-file support
  • Cloud synchronization
  • Sharing capabilities
  • More customization options
  • Plugin system

📄 License

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

🙏 Acknowledgments

📞 Contact


Made with ❤️ by Azat ESER

About

A modern and user-friendly Markdown preview application

Topics

Resources

Stars

Watchers

Forks