GitHub - Gemu03/markdown-notes: Zero-dependency client-side Markdown notes app with live preview and localStorage auto-save. Custom regex Markdown parser in vanilla JavaScript. Live: mdnotes.giovanni-moreno.com · GitHub
Skip to content

Gemu03/markdown-notes

Folders and files

Repository files navigation

Markdown Notes

A zero-dependency, client-side Markdown notes app with a live preview and auto-save — built with vanilla HTML, CSS, and JavaScript.

JavaScript HTML5 CSS3 No Dependencies License: MIT

🌐 Live Demo · Built by Giovanni Moreno


Overview

Markdown Notes is a lightweight, single-page Markdown editor that runs entirely in the browser — no backend, no build step, no dependencies. You write Markdown on the left and see the rendered HTML update live on the right. Notes are auto-saved to localStorage, so your content persists across page reloads. The Markdown-to-HTML conversion is implemented from scratch with regular expressions.

Keywords: JavaScript, vanilla JS, Markdown editor, live preview, localStorage, zero dependencies, regex parser, front-end.

✨ Features

Feature
🖋️ Live preview — renders Markdown to HTML on every keystroke
💾 Auto-save — debounced (400ms) persistence to localStorage, restored on load
🧩 Custom Markdown parser — built from scratch with regex (no libraries)
Zero dependencies — pure HTML/CSS/JS, just open the file
🎨 Styled output — headings, lists, blockquotes, inline code, links, images

📝 Supported Markdown

Syntax Renders as
# H1, ## H2, ### H3 Headings
- item Unordered list
**bold** Bold
*italic* Italic
`code` Inline code
> quote Blockquote
[text](url) Link
![alt](src) Image

🧱 Tech Stack

Vanilla HTML5 · CSS3 · JavaScript (no frameworks, no build tools) · Browser localStorage

🏗️ How It Works

flowchart TD
    E["Editor (textarea)"] -->|input event| C[app.js controller]
    C -->|render| P["parser.js (regex MD - HTML)"]
    P --> V["Preview (innerHTML)"]
    C -->|saveDebounced 400ms| LS[("localStorage")]
    LS -->|on load| C
Loading

📂 Project Structure

markdown-notes/
├── index.html   # page structure / entry point
├── style.css    # split-pane layout and preview styling
├── parser.js    # Markdown -> HTML conversion (regex)
├── app.js       # wires editor <-> preview <-> localStorage
└── README.md

🚀 Getting Started

No installation or build required:

git clone https://github.com/Gemu03/markdown-notes.git
cd markdown-notes

Then simply open index.html in your browser. Optionally serve it with any static server:

python3 -m http.server
# then visit http://localhost:8000

📝 License

This project is licensed under the MIT License — see the LICENSE file for details.

About

Zero-dependency client-side Markdown notes app with live preview and localStorage auto-save. Custom regex Markdown parser in vanilla JavaScript. Live: mdnotes.giovanni-moreno.com

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

Contributors