Skip to content

A sleek, user-friendly Markdown editor with live preview, autosave, rich formatting toolbar, and syntax highlighting. Perfect for creating documentation, notes, or blog posts with ease! πŸ’»βœ¨

License

Notifications You must be signed in to change notification settings

HashimThePassionate/markdown-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Advanced Markdown Editor πŸ“πŸš€

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. πŸ’»βœ¨


πŸ“‹ Table of Contents πŸ“š

  1. Features ✨
  2. Live Demo 🌐
  3. Installation πŸ› οΈ
  4. Usage πŸ“
  5. Project Structure πŸ“
  6. Technologies Used βš™οΈ
  7. Contributing 🀝
  8. License πŸ“œ
  9. Contact πŸ“ž

✨ Features ✨

  • 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.

🌐 Live Demo 🌐

Experience the Advanced Markdown Editor in action:

πŸ”— Live Preview Link


πŸ›  Installation πŸ› οΈ

Follow these steps to set up the project locally on your machine. πŸ–₯️

1. Clone the Repository πŸ“₯

git clone https://github.com/hashimthepassionate/markdown-editor.git

2. Navigate to the Project Directory πŸ“‚

cd markdown-editor

3. Open the 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 🐧

πŸ–ŠοΈ Usage πŸ“

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. πŸ’‘

πŸ“„ Writing Markdown ✍️

Utilize the toolbar to format your text:

  • Bold, Italic, Bold & Italic
  • Create Links 🌐
  • Insert Images Alt Text πŸ–ΌοΈ
  • Add Code Blocks with Syntax Highlighting πŸ–₯️
  • Generate Tables, Lists, Blockquotes, and more!

πŸ”„ Live Preview πŸ”„

As you type, the preview pane updates in real-time, allowing you to see the final rendered output instantly. πŸͺ„


πŸ“ Project Structure πŸ“

markdown-editor/
β”œβ”€β”€ index.html      # Main HTML file
β”œβ”€β”€ styles.css      # Custom CSS styles
β”œβ”€β”€ script.js       # JavaScript for functionality
└── README.md       # Project documentation

βš™οΈ Technologies Used βš™οΈ

  • 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.

🀝 Contributing 🀝

Contributions are welcome! πŸ’– Whether it's reporting a bug, suggesting a feature, or submitting a pull request, your input is valuable.

How to Contribute 🌟

  1. Fork the Repository 🍴

  2. Create a New Branch 🌿

    git checkout -b feature/YourFeatureName
  3. Commit Your Changes πŸ’Ύ

    git commit -m "Add your message"
  4. Push to the Branch πŸ“€

    git push origin feature/YourFeatureName
  5. Open a Pull Request πŸ”„

Please ensure your contributions adhere to the project's coding standards and include relevant documentation or tests as necessary. πŸ“


πŸ“œ License πŸ“œ

This project is licensed under the MIT License. You are free to use, modify, and distribute this project as per the license terms. πŸ”“

About

A sleek, user-friendly Markdown editor with live preview, autosave, rich formatting toolbar, and syntax highlighting. Perfect for creating documentation, notes, or blog posts with ease! πŸ’»βœ¨

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published