https://github.com/sharadj19/mdeditor
A minimal Markdown editor with real-time rendering.
https://github.com/sharadj19/mdeditor
expressjs markdown-editor marked-js mongodb nodejs tailwindcss
Last synced: 12 days ago
JSON representation
A minimal Markdown editor with real-time rendering.
- Host: GitHub
- URL: https://github.com/sharadj19/mdeditor
- Owner: SharadJ19
- Created: 2024-11-07T19:04:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-16T20:28:35.000Z (10 months ago)
- Last Synced: 2025-03-16T21:30:04.738Z (10 months ago)
- Topics: expressjs, markdown-editor, marked-js, mongodb, nodejs, tailwindcss
- Language: JavaScript
- Homepage: https://mdeditor.onrender.com/
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🖋️ Markdown Editor with Preview
Real-time markdown editor with live preview and theme toggle, backed by Node, Express, and MongoDB.
## ✨ Features
- ✅ Real-time Markdown preview as you type
- ✅ Save and retrieve Markdown files from MongoDB
- ✅ Dracula theme + optional light mode toggle
- ✅ Theme persistence via `localStorage`
- ✅ Clean, responsive, and minimal UI
## 🏷️ Tech Stack
| Layer | Tech Stack |
| ------------ | ----------------------------------- |
| **Frontend** | HTML, CSS, Tailwind CSS, JavaScript |
| **Backend** | Node.js, Express |
| **Database** | MongoDB |
| **Markdown** | Marked.js |
## 📺 Demo
🔗 **Live Demo →** *([https://mdeditor.onrender.com](https://mdeditor.onrender.com))*
## 🧪 Test Usage
This app does not require login. Just run and use directly. You can:
- ✍️ Write Markdown on the left
- 👀 See preview on the right
- 💾 Save documents by file name
- 📂 Open them back with the same name
- 🌙 Switch between Dracula and Light theme
## 🛠️ Installation
```bash
# Clone the repo
git clone https://github.com/SharadJ19/mdeditor.git
cd mdeditor
# Install dependencies
npm install
# Create a .env file and configure your MongoDB URI
# Example:
# MONGO_URI=mongodb+srv://
# Start the server
node server.js
```
Visit [`http://localhost:3000`](http://localhost:3000) in your browser.
## 👨💻 Author
📫 [Email](mailto:sharadchandel2005@gmail.com)
🔗 [LinkedIn](https://www.linkedin.com/in/sharadchandel2005/)
🌐 [Portfolio](https://sharad.is-a.dev/)
## 📝 License
🧾 This project is licensed under the **GNU General Public License v3.0**.
See the [LICENSE](./LICENSE) file for full legal details.
## 🤝 Contribution
Pull requests are welcome.
For major changes, open an issue first to discuss the idea.
🧠 Made with Markdown, Mongo, and midnight coffee ☕
