Skip to content

francccisss/markdown-app

Repository files navigation

Markdown-app (Vimnotes)

A free note taking app using vim key bindings. Visit the site here: Vimnotes

Disclaimer: I am not an expert on vim, i've been using it for only a year, that's why i only included simple vim key bindings on this app

Feature Highlights

  • Vim key bindings
  • Keyboard shortcut for navigating

Todo

  • Opting to normal mode and vim mode (for mobile users)
  • Make user able to delete their account
  • Changing password and email
  • Password recovery
  • Support for desktop app (electron and react router aren't in good terms apparently)

Keyboard Shortcuts

  • :w or ctrl+s - to write/save current note
  • :q - to close editor and open preview (can only be triggered within editor)
  • :h - to open up vim cheatsheet page ( ctrl+shift+h so you can toggle between current page and vim cheatsheet page so you can easily look up vim keybindings while using your editor for ease of access)
  • ctrl+shift+e - to toggle sidebar
  • ctrl+shift+p - to toggle between preview and editor

Reason

I've been using Simplenote for a year now and i've been loving it, but the problem is that i wanted to be able to utilize simple vim key bindings for navigation and the godsent habit of typing :w to save a file while taking notes, so that's why I built vimnotes for my own personal use.

User data

Since this is more of a pet project than an serious one, I would like for users to not use their personal credentials for signing up,
you can use whatever email you want even if its a trash email.

Preview

Screenshot from 2023-07-04 10-23-32 Screenshot from 2023-07-04 10-21-34 Screenshot from 2023-07-04 10-16-51 Screenshot from 2023-07-04 10-16-40 Screenshot from 2023-07-04 10-16-06

Tools and Libraries used

Remarkjs: a markdown library for reactjs
Electron: for creating a cross platform desktop application desktop app not available yet
Firebase: For storing user data and user authentication
Codemirror: For creating an editor on the browser with vim extension