https://github.com/danielgolden/volon

Volón is a plain text, markdown-focused, local-first notes app with text-editing keyboard shortcuts.
https://github.com/danielgolden/volon

codemirror typescript vite vue

Last synced: 10 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/danielgolden/volon
• Owner: danielgolden
• Created: 2023-01-06T21:37:01.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-26T14:06:03.000Z (3 months ago)
• Last Synced: 2024-08-26T16:34:02.377Z (3 months ago)
• Topics: codemirror, typescript, vite, vue
• Language: Vue
• Homepage: https://volon.app
• Size: 591 KB
• Stars: 29
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![readme HEader](https://user-images.githubusercontent.com/812989/215299854-049f8ae8-ca31-4468-a518-56679ea4a534.jpg)

# [Volon](https://volon.app)

Volon is a plain text, markdown-focused, local-first notes app with IDE like [text-editing keyboard shortcuts](#text-editing-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



##### Notes list and markdown preview enabled



---

## Local dev (Vue 3 + TypeScript + Vite)]

(*Subtitute `pnpm` for your package manager of choice*)

```bash

pnpm install

pnpm run dev

```

### Recommended IDE Setup

- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).

### 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)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) 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](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) 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.