extern/heynote
1
0
Fork 0
mirror of https://github.com/heyman/heynote.git synced 2024-11-24 17:03:19 +01:00
Code Issues Packages Projects Releases Wiki Activity
A dedicated scratchpad for developers
316 Commits 12 Branches 48 Tags 10 MiB
JavaScript 58.3%
Vue 23%
TypeScript 15.3%
HTML 1.2%
SCSS 1.1%
Other 1.1%
5d7af5031d
Go to file
Jonatan Heyman 5d7af5031d Improve settings dialog 
* Fix issue where it would overflow the viewport if using high enough zoom
* Some minor design improvements
2023-12-24 00:23:07 +01:00
.github/workflows Add Linux support (#6) 2023-12-21 19:18:04 +01:00
build Try to get Mac singning and notarization working in github action 2023-03-05 13:28:15 +01:00
electron Add bufferPath to config, support bufferPath symlink (#27) 2023-12-23 11:17:13 +01:00
public Use guesslang-js for language auto detection instead of Highlight.js 2023-12-06 02:52:51 +01:00
resources Mac icon pixel push 2023-01-17 00:53:15 +01:00
src Improve settings dialog 2023-12-24 00:23:07 +01:00
.gitignore Try to get Mac singning and notarization working in github action 2023-03-05 13:28:15 +01:00
electron-builder.json5 Add Linux support (#6) 2023-12-21 19:18:04 +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 Bump version to 1.4.2 2023-12-21 19:27:06 +01:00
package.json Bump version to 1.4.2 2023-12-21 19:27:06 +01:00
README.md Change tense 2023-12-23 12:17:14 +01:00
tsconfig.json Set allowJs:true in tsconfig.json 2023-01-15 12:55:12 +01:00
tsconfig.node.json Move contents of heynote-electron subdirectory into git repo root 2023-01-13 13:21:34 +01:00
vite.config.ts Add global SASS include for all Vue components 2023-12-10 22:58:33 +01:00

README.md

Heynote

GitHub release (latest SemVer)

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++
    • CSS
    • HTML
    • Java
    • JavaScript
    • JSON
    • Markdown
    • PHP
    • Python
    • Rust
    • SQL
    • XML
  • 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

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?

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.

Thanks!

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