/volon

Volón is a plain text, markdown-focused, local-first notes app with text-editing keyboard shortcuts.

Primary LanguageVue

readme HEader

Volon

Volon is a plain text, markdown-focused, local-first notes app with IDE like text-editing keyboard shortcuts. It's meant the local storage of notes, but you can also log in to sync your notes across devices. Other helpful features:

  • Multiple cursors,
  • GitHub style markdown link pasting
  • Command palette for finding notes (⌘K)

Text editing shortcuts

  • Move line up: Alt + Up
  • Move line down: Alt + Down
  • Copy line up: Shift + Alt + Up
  • Copy line down: Shift + Alt + Down
  • Insert blank line: Cmd + Enter (Ctrl + Enter on Windows)
  • Select line: Ctrl + l (Alt + l on Windows)
  • Indent less: Cmd + [ (Ctrl + [ on Windows)
  • Indent more: Cmd + ] (Ctrl + ] on Windows)
  • Delete line: Shift + Cmd + k (Shift + Ctrl + k on Windows)
  • Toggle comment: Cmd + / (Ctrl + / on Windows)
  • Bold: Cmd + b
  • Italicize: Cmd + i

Screenshots

Minimal UI

Captura de Pantalla 2023-01-28 a la(s) 9 08 02 p m

Notes list and markdown preview enabled

Captura de Pantalla 2023-01-28 a la(s) 9 08 22 p m


Local dev (Vue 3 + TypeScript + Vite)]

(Subtitute pnpm for your package manager of choice)

pnpm install
pnpm run dev

Recommended IDE Setup

Type Support For .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

  1. Disable the built-in TypeScript Extension
    1. Run Extensions: Show Built-in Extensions from VSCode's command palette
    2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
  2. Reload the VSCode window by running Developer: Reload Window from the command palette.