Skip to content

A real-time Markdown editor built with React (Vite), Node.js (Express), and Tailwind CSS . It provides live preview, syntax highlighting, file download, and theme customization .

Notifications You must be signed in to change notification settings

penandcode/inksync

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

InkSync📝🚀

A real-time Markdown editor built with React (Vite), Node.js (Express), and Tailwind CSS . It provides live preview, syntax highlighting, file download, and theme customization .


📌 Features

Real-time Markdown to HTML conversion

File download as .md

Rate limiting on backend for security


🛠️ Tech Stack

  • Frontend: React (Vite), Tailwind CSS, Remark-GFM
  • Backend: Node.js, Express, Remark-GFM, Helmet, CORS
  • Deployment: Vercel (Frontend) & Render (Backend)

🚀 Getting Started (Run Locally)

📌 1. Clone the Repository

git clone https://github.com/penandcode/inksync.git
cd inksync

📌 2. Setup Backend

npm install
npm start

🚀 Backend runs on: http://localhost:8082

📌 3. Setup Frontend

cd frontend
npm install
npm run dev

🚀 Frontend runs on: http://localhost:5173

📝 API Endpoints

Method Endpoint Description
POST /convert Convert Markdown to HTML

Example Request:

{
  "content": "# Hello Markdown!"
}

Example Response:

{
  "html": "<h1>Hello Markdown!</h1>"
}

🎯 Deployment

Frontend

  • Deployed on Vercel
  • Build & Deploy:
    npm run build

Backend

  • Deployed on Render
  • Start server:
    node server.js

About

A real-time Markdown editor built with React (Vite), Node.js (Express), and Tailwind CSS . It provides live preview, syntax highlighting, file download, and theme customization .

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published