Skip to content

About

A minimal browser-based note-taking app where notes are written in Markdown and rendered live side-by-side in real time.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

✦ Inkwell — Markdown Notes App

A minimal, beautiful browser-based markdown note-taking app with live side-by-side preview.

No installs. No servers. No accounts. Just open index.html and write.


✨ Features

  • Live preview — markdown renders instantly as you type
  • Multiple notes — tab-based note management
  • Auto-save — notes persist in localStorage automatically
  • Resizable panes — drag the divider to resize editor and preview
  • Syntax highlighting — code blocks with language support via highlight.js
  • Layout modes — split / editor-only / preview-only (toggle with button or Ctrl+P)
  • Copy HTML — copy the rendered HTML to clipboard in one click
  • Zero dependencies — no build step, no npm, no frameworks
  • Fully offline — works without internet (CDN libs load once and cache)

🚀 Getting Started

Option 1 — Open directly:

Just open index.html in any modern browser.

Option 2 — GitHub Pages:

  1. Push this repo to GitHub
  2. Go to Settings → Pages → Source: main branch, / (root)
  3. Your app is live at https://YOUR_USERNAME.github.io/REPO_NAME

Option 3 — Local server:

npx serve .
# or
python -m http.server 8080

⌨️ Keyboard Shortcuts

Shortcut Action
Ctrl+N New note
Ctrl+S Save now
Ctrl+P Toggle layout
Tab Indent (in editor)
Enter (in title) Jump to editor

🗂 Project Structure

markdown-notes/
├── index.html        ← App shell & markup
├── css/
│   └── style.css     ← All styles (dark editorial theme)
├── js/
│   └── app.js        ← All logic (notes, rendering, storage)
└── README.md

🛠 Tech Stack

Library Purpose
marked.js v9 Markdown → HTML parsing
highlight.js v11 Code syntax highlighting
Vanilla JS Everything else

No build tools, no bundlers, no frameworks.


📝 Markdown Support

  • Headings, paragraphs, bold, italic
  • Code blocks with syntax highlighting
  • Tables, blockquotes, horizontal rules
  • Ordered & unordered lists
  • Links & images
  • GitHub Flavored Markdown (GFM)

License

MIT © 2024

About

A minimal browser-based note-taking app where notes are written in Markdown and rendered live side-by-side in real time.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages