extern/heynote
1
0
Fork 0
mirror of https://github.com/heyman/heynote.git synced 2024-11-24 00:43:12 +01:00
Code Issues Packages Projects Releases Wiki Activity
A dedicated scratchpad for developers
452 Commits 12 Branches 48 Tags 10 MiB
JavaScript 58.3%
Vue 23%
TypeScript 15.3%
HTML 1.2%
SCSS 1.1%
Other 1.1%
main
Go to file
Jonatan Heyman ca38f9f932
Fix link 
Signed-off-by: Jonatan Heyman <jonatan@heyman.info>
2024-07-24 16:46:09 +02:00
.github
assets
build
docs Fix link 2024-07-24 16:46:09 +02:00
electron Improve handling of global hotkey in Linux. 2024-07-24 16:42:34 +02:00
public Guesslang does not support Vue 2024-07-14 12:45:35 +02:00
resources
shared-utils
src Fix error on startup when cursor is moved to the end of a large buffer (caused by the syntaxTree not being parsed in time) 2024-07-14 14:51:15 +02:00
tests Add test for custom default block language 2024-07-14 12:19:29 +02:00
webapp
.gitignore
electron-builder.json5
index.html
LICENSE
package-lock.json Bump version to 1.8.0 2024-07-14 15:39:25 +02:00
package.json Bump version to 1.8.0 2024-07-14 15:39:25 +02:00
playwright.config.ts
README.md Add Vue to supported languages list in README 2024-07-14 14:55:26 +02:00
tsconfig.json
tsconfig.node.json
vite.config.mjs Add links to documentation in Readme 2024-07-08 14:48:45 +02: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, 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.

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?

See the documentation.

Thanks!

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