mirror of
https://github.com/heyman/heynote.git
synced 2025-01-03 04:28:57 +01:00
Update docs and changelog
This commit is contained in:
parent
374e2b4e5d
commit
4833db9928
@ -6,14 +6,15 @@ Here are the most notable changes in each release. For a more detailed list of c
|
|||||||
|
|
||||||
### Support for multiple note buffers.
|
### Support for multiple note buffers.
|
||||||
|
|
||||||
Apart from the default scratch buffer, you can now create and switch between multiple note buffers. By pressing `Ctrl/Cmd+S` you can create a new note from the current block (the current block will be moved into the new note). New note buffers are saved to the note library which is basically a directories (with sub dirs) on the disk with `.txt` files. You switch between note buffers by pressing `Ctrl/Cmd+P`.
|
Apart from the default Scratch note, you can now create and switch between multiple notes. By pressing `Ctrl/Cmd+S` you can create a new note from the current block (the current block will be moved into the new note). New notes are saved to the note library which is basically a directory (with sub dirs) on the disk with a `.txt` file for each note. You switch between Notes by pressing `Ctrl/Cmd+P`.
|
||||||
|
|
||||||
The first time you start the new version of Heynote, your existing buffer file will be migrated to the new note library. If you're using the default buffer location, that means that the existing scratch buffer file will be moved from `%APP_DIR%/buffer.txt` to `%APP_DIR%/notes/scratch.txt`. If you are using a custom buffer location the file will be moved from `%CUSTOM_DIR%/buffer.txt` to `%CUSTOM_DIR%/scratch.txt`.
|
The first time you start the new version of Heynote, your existing buffer file will be migrated to the new note library. If you're using the default buffer location, that means that the existing Scratch note file will be moved from `%APP_DIR%/buffer.txt` to `%APP_DIR%/notes/scratch.txt`. If you are using a custom buffer location the existing scratch file will be moved from `%CUSTOM_DIR%/buffer.txt` to `%CUSTOM_DIR%/scratch.txt`.
|
||||||
|
|
||||||
### Other changes
|
### Other changes
|
||||||
|
|
||||||
- The file format for the buffer files has been updated to include some JSON metadata at the top of the file.
|
- The file format for the buffer files has been updated to include some JSON metadata at the top of the file.
|
||||||
- The cursor(s) location is saved between sessions.
|
- The cursor(s) location is saved between sessions.
|
||||||
|
- Improvements when using a file syncing service (e.g. Dropbox, OneDrive) to sync the note library between machines.
|
||||||
- The setting for changing the color theme is now located in the program settings, instead of in the status bar.
|
- The setting for changing the color theme is now located in the program settings, instead of in the status bar.
|
||||||
|
|
||||||
## 1.8.0
|
## 1.8.0
|
||||||
|
@ -101,16 +101,27 @@ format(x) = x.toLocaleString();
|
|||||||
format(x) = x.toLocaleString('en-GB');
|
format(x) = x.toLocaleString('en-GB');
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
See the [Math.js format()](https://mathjs.org/docs/reference/functions/format.html) function for more info on what's supported.
|
See the [Math.js format()](https://mathjs.org/docs/reference/functions/format.html) function for more info on what's supported.
|
||||||
|
|
||||||
## The buffer file
|
|
||||||
|
|
||||||
The default paths for the buffer data for the respective operating systems are:
|
## The notes library (only for Heynote 2.0, not yet released)
|
||||||
|
|
||||||
|
The notes library is a directory (with sub dirs) on the disk with a `.txt` file for each note. It's created the first time you start Heynote, with the default note file `scratch.txt` in it. The default location for the library is:
|
||||||
|
|
||||||
|
- Mac: `~/Library/Application Support/Heynote/notes/`
|
||||||
|
- Windows: `%APPDATA%\Heynote\notes\`
|
||||||
|
- Linux: `~/.config/Heynote/notes/`
|
||||||
|
|
||||||
|
You can change the path of the notes library in the settings. Heynote expects reasonably fast disk access to the notes library, so it's not recommended to use a network drive, though file syncing services like Dropbox, OneDrive, etc. should work (see below).
|
||||||
|
|
||||||
|
## Synchronizing the notes library
|
||||||
|
|
||||||
|
Heynote is built to support synchronizing the notes library (or buffer file in the case of Heynote 1.x) through file-syncing services like Dropbox, OneDrive, etc. However, note that the synchronization logic is quite simple, so editing the same note on two different machines at the same time might lead to conflicts and unexpected results.
|
||||||
|
|
||||||
|
When using a file synching service that support "offloading" of files in the cloud (removing them from the disk), it's recommended to mark the notes library as "always available offline".
|
||||||
|
|
||||||
|
As always, backups things that are important.
|
||||||
|
|
||||||
- Mac: `~/Library/Application Support/Heynote/buffer.txt`
|
|
||||||
- Windows: `%APPDATA%\Heynote\buffer.txt`
|
|
||||||
- Linux: `~/.config/Heynote/buffer.txt`
|
|
||||||
|
|
||||||
## Linux
|
## Linux
|
||||||
|
|
||||||
@ -124,7 +135,7 @@ libnss3
|
|||||||
libnspr4
|
libnspr4
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Wayland
|
### Wayland
|
||||||
|
|
||||||
Due to [an issue in Electron](https://github.com/electron/electron/issues/38288), the global hotkey will not work in all applications running under Wayland. In KDE it is possible to work around this limitation by adding this Kwin script:
|
Due to [an issue in Electron](https://github.com/electron/electron/issues/38288), the global hotkey will not work in all applications running under Wayland. In KDE it is possible to work around this limitation by adding this Kwin script:
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user