MDlens is a modern markdown editor and previewer built with React, Tailwind CSS, and Marked.js. With its simplistic UI, users can seamlessly write, edit, and preview markdown side-by-side, without distractions. MDlens empowers developers, writers, and content creators with tools for clean and efficient markdown formatting.
- Live Markdown Preview: See changes in real time as you type.
- Responsive Design: Adapts seamlessly to any screen size, offering a side-by-side layout for desktops and a stacked view for mobile.
- Formatting Toolbar: Bold, italicize, or create headers effortlessly using a user-friendly toolbar.
- Simple UI: Tailwind CSS and DaisyUI offer a modern, accessible design.
- Markdown Rendering: Powered by Marked.js, supporting a wide range of markdown syntax.
Check out a live version of MDlens here.
Follow these instructions to set up MDlens on your local machine for development or testing.
- Node.js (v16 or later)
- npm (v8 or later) or yarn (optional)
- Clone the repository:
git clone https://github.com/your-username/MDlens.git
- Navigate to the project directory:
cd MDlens - Install dependencies:
npm install
- Start the development server:
npm run dev
- Write Markdown: Use the editor on the left to type raw markdown.
- Preview Changes: Watch your markdown render live on the right panel.
- Apply formatting: Highlight text and use the toolbar for bold, italics, headers, and more.
We welcome contributions to improve MDlens! Follow these steps to contribute:
- Fork this repository.
- Create a feature branch:
git checkout -b feature-name
- Commit your changes:
git commit -m "Add new feature" - Push the branch:
git push origin feature-name
- Open a Pull Request on GitHub.
This project is licensed under the MIT License. See the LICENSE file for details.
Special thanks to the following technologies and libraries that made this project possible:
Feel free to reach out or create an issue for any questions or suggestions. We hope you enjoy using MDlens as much as we enjoyed building it! 😊