PrevueMD: A real-time Markdown editor built in Vue 3. Try it out!

This was the first app I built after learning Vue; from ideation and design to development and deployment.
I did not like the markdown editor on GitHub, so I decided to build my own.

Learn about the development process.

Features

• 🚀 Real-time preview as you type
• 💾 Export to markdown file
• 📋 Copy to clipboard functionality

Usage

1. Begin writing markdown in the editor.
2. See the live preview as you type.
3. Copy or download your code.

Local Development Setup

1. Prerequisites

   • Node.js 16 or higher
   • pnpm package manager

2. Installation

git clone https://github.com/wazeerc/PrevueMD.git
cd PrevueMD
pnpm install

3. Development

pnpm dev        # Start development server
pnpm test       # Run tests
pnpm build      # Build for production

4. Access the development server at http://localhost:5173

Built With

• Playwright - E2E testing
• Remark - Plugins
• Tailwind CSS - For styling
• Unified - For markdown processing
• Vite - Build tool and dev server
• Vitest - Unit testing
• Vue 3 - Progressive JavaScript Framework
• Vue Toastification - Toast notifications

Contributing

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

Status