mirror of
https://github.com/heyman/heynote.git
synced 2024-12-22 06:31:06 +01:00
Add links to documentation in Readme
This commit is contained in:
Jonatan Heyman
parent
4890cd6a6b
commit
d6420e65e8
81
README.md
81
README.md
@ -31,19 +31,9 @@ Available for Mac, Windows, and Linux.
|
||||
- Default or Emacs-like key bindings
|
||||
|
||||
|
||||
## Installation
|
||||
## Documentation
|
||||
|
||||
Download the appropriate (Mac, Windows or Linux) version from the latest Github release (or from [heynote.com](https://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)](https://github.com/heyman/heynote/issues/48) that ChromeOS's Debian VM need the following packages installed to run the Heynote AppImage:
|
||||
|
||||
```
|
||||
libfuse2
|
||||
libnss3
|
||||
libnspr4
|
||||
```
|
||||
[Documentation](https://heynote.com/docs/) is available on the Heynote website.
|
||||
|
||||
## Development
|
||||
|
||||
@ -73,42 +63,12 @@ To run the tests in the Playwright UI:
|
||||
|
||||
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](https://mathjs.org/docs/expressions). Checkout their [documentation](https://mathjs.org/docs/) to see what [syntax](https://mathjs.org/docs/expressions/syntax.html), [functions](https://mathjs.org/docs/reference/functions.html), and [constants](https://mathjs.org/docs/reference/constants.html) 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()](https://mathjs.org/docs/reference/functions/format.html) 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.
|
||||
See the [documentation](https://heynote.com/docs/#user-content-the-buffer-file).
|
||||
|
||||
### Can you make a mobile app?
|
||||
|
||||
@ -122,40 +82,7 @@ I can totally see the usefulness of such a feature, and it's definitely somethin
|
||||
|
||||
### What are the default keyboard shortcuts?
|
||||
|
||||
<!-- 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
|
||||
```
|
||||
See the [documentation](https://heynote.com/docs/#user-content-default-key-bindings).
|
||||
|
||||
## Thanks!
|
||||
|
||||
|
||||
@ -17,9 +17,7 @@ rmSync('dist-electron', { recursive: true, force: true })
|
||||
const isDevelopment = process.env.NODE_ENV === "development" || !!process.env.VSCODE_DEBUG
|
||||
const isProduction = process.env.NODE_ENV === "production"
|
||||
|
||||
const updateReadmeKeybinds = async () => {
|
||||
const readmePath = path.resolve(__dirname, 'README.md')
|
||||
let readme = fs.readFileSync(readmePath, 'utf-8')
|
||||
const injectKeybindsInDocs = async () => {
|
||||
const keybindsRegex = /^(<!-- keyboard_shortcuts -->\s*).*?^(```\s+#)/gms
|
||||
const shortcuts = `$1**On Mac**
|
||||
|
||||
@ -32,9 +30,6 @@ ${keyHelpStr('darwin')}
|
||||
\`\`\`
|
||||
${keyHelpStr('win32')}
|
||||
$2`
|
||||
readme = readme.replace(keybindsRegex, shortcuts)
|
||||
fs.writeFileSync(readmePath, readme)
|
||||
|
||||
const docsPath = path.resolve(__dirname, 'docs', 'index.md')
|
||||
let docs = fs.readFileSync(docsPath, 'utf-8')
|
||||
docs = docs.replace(keybindsRegex, shortcuts)
|
||||
@ -61,7 +56,7 @@ export default defineConfig({
|
||||
|
||||
plugins: [
|
||||
vue(),
|
||||
updateReadmeKeybinds(),
|
||||
injectKeybindsInDocs(),
|
||||
updateGuesslangLanguagesInWebWorker(),
|
||||
electron([
|
||||
{
|
||||
|
||||
Loading…
Reference in New Issue
Block a user