Welcome to the Advanced Markdown Editor! This project provides a sleek and user-friendly interface for creating and previewing Markdown documents in real-time. Whether you're writing documentation, notes, or blog posts, this editor is designed to enhance your Markdown editing experience. π»β¨
- Features β¨
- Live Demo π
- Installation π οΈ
- Usage π
- Project Structure π
- Technologies Used βοΈ
- Contributing π€
- License π
- Contact π
- Live Preview π: See your Markdown rendered in real-time as you type.
- Rich Toolbar π οΈ: Access common Markdown formatting options with ease.
- Autosave πΎ: Your work is automatically saved to local storage to prevent data loss.
- Responsive Design π±: Optimized for both desktop and mobile devices.
- Customizable π¨: Easily tweak styles and functionalities to fit your needs.
- Syntax Highlighting π: Enhanced readability for code blocks with syntax highlighting.
Experience the Advanced Markdown Editor in action:
π Live Preview Link
Follow these steps to set up the project locally on your machine. π₯οΈ
git clone https://github.com/hashimthepassionate/markdown-editor.git
cd markdown-editor
Simply open the index.html
file in your preferred web browser.
-
Option 1: Double-click the
index.html
file. -
Option 2: Use the command line:
open index.html # For macOS π start index.html # For Windows π₯οΈ xdg-open index.html # For Linux π§
Once you've opened the editor, you can start typing your Markdown content in the left pane. The right pane will display a live preview of your rendered Markdown. π‘
Utilize the toolbar to format your text:
- Bold, Italic, Bold & Italic
- Create Links π
- Insert Images
- Add Code Blocks with Syntax Highlighting π₯οΈ
- Generate Tables, Lists, Blockquotes, and more!
As you type, the preview pane updates in real-time, allowing you to see the final rendered output instantly. πͺ
markdown-editor/
βββ index.html # Main HTML file
βββ styles.css # Custom CSS styles
βββ script.js # JavaScript for functionality
βββ README.md # Project documentation
- HTML5 π: Structure of the application.
- CSS3 π¨: Styling and responsive design.
- JavaScript (ES6) π οΈ: Interactive functionalities.
- EasyMDE ποΈ: A simple, embeddable, and beautiful Markdown editor.
- CDN Libraries π: Leveraging Content Delivery Networks for EasyMDE and other dependencies.
Contributions are welcome! π Whether it's reporting a bug, suggesting a feature, or submitting a pull request, your input is valuable.
-
Fork the Repository π΄
-
Create a New Branch πΏ
git checkout -b feature/YourFeatureName
-
Commit Your Changes πΎ
git commit -m "Add your message"
-
Push to the Branch π€
git push origin feature/YourFeatureName
-
Open a Pull Request π
Please ensure your contributions adhere to the project's coding standards and include relevant documentation or tests as necessary. π
This project is licensed under the MIT License. You are free to use, modify, and distribute this project as per the license terms. π