Markdown Live Preview Editor

GitHub generally shows the preview of the README.md files after you've uploaded it and that's not ideal, also it makes much more sense to have basic templates of your README files ready for use in newer repositories, and that's why I made this app.

📋 Table of Contents

1. 🤖 Introduction
2. ⚙️ Tech Stack
3. 🔋 Features
4. 🤸 Quick Start

🚨 Tutorial

This repository contains the code corresponding to an in-depth tutorial on how to use this app on my YouTube channel, Yash Bhalgat.

🤖 Introduction

A modern Markdown Editor that lets you write, preview, and share your markdown documents in real time. Our app offers a seamless writing experience with auto-saving, dark/light themes, and robust community features.

⚙️ Tech Stack

• React.js
• TypeScript
• shadcn-ui
• Vite
• Tailwind CSS
• Supabase

🔋 Features

👉 Real-time Preview: Instantly see your formatted markdown in a split-screen view as you type.

👉 Publish & Share: Effortlessly publish your markdown documents to a public community feed and explore content created by others.

👉 Auto-Saving: Enjoy worry-free writing with automatic saving, so you never lose your progress.

👉 Dark & Light Modes: Customize your editing experience with flexible theme options to suit your mood and environment.

👉 Import & Export: Easily import published markdowns into the editor for further editing, export documents as markdown files, or copy them to the clipboard.

👉 Community Engagement: Like and interact with posts in the community feed to discover trending content.

…and many more features focused on robust code architecture, reusability, and a seamless user experience.

🤸 Quick Start

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

• Git
• Node.js
• npm (Node Package Manager)

Cloning the Repository

git clone REPOSITORY_URL
cd repository-name

Installation

Install the project dependencies using npm:

npm install

Running the Project

npm run dev

Open http://localhost:8080 in your browser to view the project.