A dedicated scratchpad for developers
Go to file
2024-07-08 14:14:21 +02:00
.github Change title format in issue template 2024-01-05 02:13:41 +01:00
assets Add Settings to web app (#125) 2024-01-04 14:27:04 +01:00
build Remove unnessecary entitlements 2024-01-25 23:09:30 +01:00
docs Add documentation, and update code that injects key bindings to also inject it into the docs 2024-07-08 14:00:18 +02:00
electron Add menu item to Help menu that opens documentation page 2024-07-08 14:14:21 +02:00
public Add .webmanifest to web app 2024-02-26 18:22:52 +01:00
resources Mac icon pixel push 2023-01-17 00:53:15 +01:00
shared-utils Change order of key bindings in help text 2024-01-04 16:16:21 +01:00
src Add test that ensures that getBlocksFromSyntaxTree() and getBlocksFromString() functions produces the same results 2024-07-07 22:05:33 +02:00
tests Add test that ensures that getBlocksFromSyntaxTree() and getBlocksFromString() functions produces the same results 2024-07-07 22:05:33 +02:00
webapp Add .webmanifest to web app 2024-02-26 18:22:52 +01:00
.gitignore Implement tests using Playwright (#68) 2023-12-25 17:41:15 +01:00
electron-builder.json5 Fix broken windows build by adding old favicon.ico as icon.ico and pointing to it in electron-builder config 2024-01-05 01:16:34 +01:00
index.html Turn off nodeIntegration. Without it disabled, Math.js does not work in production build. 2023-03-02 20:59:13 +01:00
LICENSE Add license info 2023-03-14 14:12:04 +01:00
package-lock.json Update prettier to latest version 2024-07-07 22:05:33 +02:00
package.json Update prettier to latest version 2024-07-07 22:05:33 +02:00
playwright.config.ts Fix test on linux/windows 2024-01-06 01:51:07 +01:00
README.md Add documentation, and update code that injects key bindings to also inject it into the docs 2024-07-08 14:00:18 +02:00
tsconfig.json Add key bindings for inserting new blocks at the end/top of the buffer, as well as before the current block (#85) 2024-01-04 16:11:26 +01:00
tsconfig.node.json Avoid code duplication by auto building the GUESSLANG_LANGUAGES list in langdetect-worker.js from the src/editor/languages.js:LANGUAGES list. 2024-02-09 16:02:07 +01:00
vite.config.mjs Add documentation, and update code that injects key bindings to also inject it into the docs 2024-07-08 14:00:18 +02:00

Heynote

GitHub release (latest SemVer) Build Status

Website: heynote.com

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, Go, Groovy, HTML, Java, JavaScript, JSX, Kotlin, TypeScript, TOML, TSX, JSON, Lezer, Markdown, PHP, Python, Ruby, Rust, Shell, SQL, Swift, 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

Installation

Download the appropriate (Mac, Windows or Linux) version from the latest Github release (or from heynote.com). The Windows build is not signed, so you might see some scary warning (I can not justify paying a yearly fee for a certificate just to get rid of that).

Notes on Linux installation

It's been reported (#48) that ChromeOS's Debian VM need the following packages installed to run the Heynote AppImage:

libfuse2
libnss3
libnspr4

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.

Math Blocks

Heynote's Math blocks are powered by Math.js expressions. Checkout their documentation to see what syntax, functions, and constants are available.

Accessing the previous result

The variable prev can be used to access the previous result. For example:

128
prev * 2 # 256

Changing how the results of Math blocks are formatted?

You can define a custom format function within the Math block like this:

_format = format # store reference to the built in format
format(x) = _format(x, {notation:"exponential"})

See the Math.js format() function for more info on what's supported.

FAQ

Where is the buffer data stored?

The default paths for the buffer data for the respective OS are:

  • Mac: ~/Library/Application Support/Heynote/buffer.txt
  • Windows: %APPDATA%\Heynote\buffer.txt
  • Linux: ~/.config/Heynote/buffer.txt

From version >=1.5.0, symlinks will be supported and you'll be able to configure the path where buffer.txt is stored.

Can you make a mobile app?

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

Can you add a feature for naming blocks and/or adding tags? (#44)

Currently, I'm not planning on adding this. The main reason is that it goes against the scratchpadness of the program.

I can totally see the usefulness of such a feature, and it's definitely something that I would expect from a more traditional Notes app. However a large part of Heynote's appeal is it's simplicity, and if that is to remain so, I'm going to have to say no to a lot of actually useful features.

What are the default keyboard shortcuts?

On Mac

⌘ + Enter           Add new block below the current block
⌥ + Enter           Add new block before the current block
⌘ + Shift + Enter   Add new block at the end of the buffer
⌥ + Shift + Enter   Add new block at the start of the buffer
⌘ + ⌥ + Enter       Split the current block at cursor position
⌘ + L               Change block language
⌘ + Down            Goto next block
⌘ + Up              Goto previous block
⌘ + A               Select all text in a note block. Press again to select the whole buffer
⌘ + ⌥ + Up/Down     Add additional cursor above/below
⌥ + Shift + F       Format block content (works for JSON, JavaScript, HTML, CSS and Markdown)

On Windows and Linux

Ctrl + Enter           Add new block below the current block
Alt + Enter            Add new block before the current block
Ctrl + Shift + Enter   Add new block at the end of the buffer
Alt + Shift + Enter    Add new block at the start of the buffer
Ctrl + Alt + Enter     Split the current block at cursor position
Ctrl + L               Change block language
Ctrl + Down            Goto next block
Ctrl + Up              Goto previous block
Ctrl + A               Select all text in a note block. Press again to select the whole buffer
Ctrl + Alt + Up/Down   Add additional cursor above/below
Alt + Shift + F        Format block content (works for JSON, JavaScript, HTML, CSS and Markdown)
Alt                    Show menu

Thanks!

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