Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 1.18 KB

README.md

File metadata and controls

38 lines (23 loc) · 1.18 KB

SvelteKit Markdown Notes

A simple static web app for editing / reading notes in markdown.

Live version here

nb: registered email address and note text are not encrypted. Don't put anything sensitive in this project.

About

Notes are rendered in realtime and with toggle-able edit / read panels.

Mostly for practice with Sveltekit and Firebase.

Technology

Written in Typescript in the SvelteKit framework.

Markdown parser through the marked npm package.

Authentication, Hosting, and document storage through Google firebase.

Usage

  • Create note Create new note
  • ✏️ Toggle edit pane
  • 👁️ Toggle read pane
  • 🏷️ Toggle tags input (click tag itself to remove)
  • 📌 Pin current note (top bar) / Unpin note (note in list)
  • ⚙️ Show settings pane
  • 👤 Show account pane

Search bar will filter all notes to include those where the title or tags contain the searched string*.

Order By drop down will order notes based on the given selection*.

* Same filter is applied to pinned notes, but they are always kept at the top.