extern/heynote
1
0
Fork 0
mirror of https://github.com/heyman/heynote.git synced 2025-02-01 19:09:33 +01:00
Code Issues Packages Projects Releases Wiki Activity
A dedicated scratchpad for developers
568 Commits 16 Branches 55 Tags 12 MiB
JavaScript 58.6%
Vue 31.4%
TypeScript 7.6%
HTML 0.9%
SCSS 0.8%
Other 0.7%
v2.1.1
Go to file
Jonatan Heyman a4b187ed49 Bump version to 2.1.1
2025-01-15 14:16:23 +01:00
.github Also trigger website build when a release is published 2025-01-10 14:20:36 +01:00
assets
build
docs Fix "note" -> "buffer" terminology 2025-01-15 14:15:33 +01:00
electron Fix broken sub directories on Windows 2025-01-15 14:15:33 +01:00
public
resources
shared-utils Add feature for moving the current block to another buffer 2025-01-07 23:17:23 +01:00
src Fix broken sub directories on Windows 2025-01-15 14:15:33 +01:00
tests Position the cursor at the beginning of the next block when a block is deleted 2025-01-09 14:16:20 +01:00
webapp Fix broken sub directories on Windows 2025-01-15 14:15:33 +01:00
.gitignore
electron-builder.json5
index.html
LICENSE
package-lock.json Bump version to 2.1.1 2025-01-15 14:16:23 +01:00
package.json Bump version to 2.1.1 2025-01-15 14:16:23 +01:00
playwright.config.ts Make sure __TESTS__ is defined when running tests 2025-01-06 15:02:11 +01:00
README.md Update docs and readme 2025-01-09 21:51:26 +01:00
tsconfig.json Fix issue causing vite build not to work 2025-01-07 23:37:36 +01:00
tsconfig.node.json
vite.config.mjs * Add window.heynote.mainProcess.on() and off() which can be used in browser land to communicate with the main process. Use these methods to remove intermediate onOpenSettings() and onSettingsChange() methods from window.heynote objects. 2025-01-06 16:20:00 +01:00

README.md

Heynote

GitHub release (latest SemVer) Build Status

General Information

Heynote is a dedicated scratchpad for developers. It functions as a large persistent text buffer where you can write down anything you like. Works great for that Slack message you don't want to accidentally send, a JSON response from an API you're working with, notes from a meeting, your daily to-do list, etc.

The Heynote buffer is divided into blocks, and each block can have its own Language set (e.g. JavaScript, JSON, Markdown, etc.). This gives you syntax highlighting and lets you auto-format that JSON response.

Available for Mac, Windows, and Linux.

Features

  • Persistent text buffer

  • Block-based

  • Syntax highlighting:

    C++, C#, Clojure, CSS, Erlang, Dart, Go, Groovy, HTML, Java, JavaScript, JSX, Kotlin, TypeScript, TOML, TSX, JSON, Lezer, Markdown, PHP, Python, Ruby, Rust, Scala, Shell, SQL, Swift, Vue, XML, YAML

  • Language auto-detection

  • Auto-formatting

  • Math/Calculator mode

  • Currency conversion

  • Multi-cursor editing

  • Dark & Light themes

  • Option to set a global hotkey to show/hide the app

  • Default or Emacs-like key bindings

Documentation

Documentation is available on the Heynote website.

Development

To develop Heynote you need Node.js and you should (hopefully) just need to check out the code and then run:

> npm install
> npm run dev

Run Tests

To run the tests:

> npm run test

To run the tests in the Playwright UI:

> npm run test:ui

Contributions

I'm happy to merge contributions that fit my vision for the app. Bug fixes are always welcome.

FAQ

Where is the buffer data stored?

See the documentation.

Can you make a mobile app?

No, at the moment this is out of scope, sorry.

What are the default keyboard shortcuts?

See the documentation.

Thanks!

Heynote is built upon CodeMirror, Vue, Electron, Math.js, Prettier and other great open-source projects.