Skip to content

CevdetTufan/markdown-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

12 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

MarkdownForge

MarkdownForge Preview License

πŸš€ Try the Live Demo Here!

MarkdownForge is a beautiful, premium, and fully browser-based Markdown editor and viewer. It is designed to work entirely client-side without any back-end requirements, databases, or build steps. Just open the HTML file, and you are ready to write.

✨ Features

  • πŸŒ“ Light & Dark Theme: Premium, carefully crafted color palettes for both light and dark modes with a simple toggle.
  • ⚑ Live Preview: See your Markdown rendered to HTML in real-time as you type.
  • 🎨 Syntax Highlighting: Beautiful code blocks powered by highlight.js.
  • πŸ›‘οΈ Secure: Markdown output is sanitized using DOMPurify to prevent XSS vulnerabilities.
  • ↔️ Resizable Panes: Dynamically adjust the width of the editor and preview areas to suit your workflow.
  • πŸ’Ύ Auto-Save: Never lose your progress. Your document is automatically saved to your browser's localStorage.
  • πŸ“₯ Download & Export: Download your work as a .md file directly to your device or copy the generated HTML with one click.
  • πŸš€ Zero Installation: Built with Vanilla HTML, CSS, and JS using CDN libraries. No npm install, Node.js, or complex setups required.

πŸ› οΈ Built With

  • HTML5 & CSS3: With modern flexbox layouts and CSS variables.
  • Vanilla JavaScript: Pure, lightweight logic.
  • Marked.js: For fast and accurate Markdown parsing.
  • DOMPurify: For robust XSS sanitization.
  • Highlight.js: For code syntax highlighting.
  • FontAwesome: For clean and scalable UI icons.
  • Google Fonts: Inter & Fira Code for a premium typographic experience.

πŸš€ Getting Started

Running Locally

  1. Clone this repository or download the ZIP file.
    git clone https://github.com/yourusername/markdown-editor.git
  2. Navigate to the folder.
  3. Simply double-click on index.html to open it in your default web browser.

Hosting on GitHub Pages

Because MarkdownForge requires no build steps, it is perfectly suited for GitHub Pages.

  1. Push this repository to your GitHub account.
  2. Go to your repository Settings.
  3. Navigate to the Pages section on the left sidebar.
  4. Under "Build and deployment", select the main branch as your source.
  5. Save, and your editor will be live and accessible from anywhere!

πŸ“ License

This project is open-source and available under the MIT License. Feel free to fork, modify, and use it in your own projects!


Developed with πŸ€– GitHub Copilot

About

A beautiful, browser-based Markdown editor with live preview, dark mode, and zero installation. Developed with GitHub Copilot πŸ€–.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors