Add addon installation instructions

This commit is contained in:
lolabird 2024-10-12 00:24:59 -06:00
commit 705e36dcf5
No known key found for this signature in database
GPG key ID: 91363E5F20E63A5B

View file

@ -29,6 +29,46 @@ This is a [Trilium Notes](https://github.com/zadam/trilium) theme to go with Eve
* Under "Theme", choose EverForest Ant Dark
* Enjoy!
### Enabling Addon Features
#### Zen Mode
* Create a 'JS frontend' code note
* Add the `#widget` attribute to 'Owned Attributes' (the button with three lines and a checkmark)
* Add the following code (created by [Nriver](https://github.com/Nriver/awesome-trilium/issues/44))) to the note
```js
api.addButtonToToolbar({
title: 'Zen mode',
icon: 'spa',
action: function() {
$("body").toggleClass("zen-mode");
},
shortcut: 'alt+z'
});
```
* Reload (`ctrl+r` or `F5`) Trilium to enable the script
##### Usage
Press `alt+z` or the zen (spa) button in the launcher (left most panel) to enable/disable zen mode.
There are two types of zen mode available:
1. Right panel enabled
2. Right panel disabled
Right panel is enabled by default. If you would like to disable it, you can either add the following code in a new CSS note or uncomment it in the Stellar Dark theme as seen in the video below.
![Zen Mode](/screenshots/EFAD_Zen.mp4)
##### Added Features
* Window control buttons are still accessible in zen mode
* Zen button is still accessible in zen mode for easy disabling in case you don't remember the shortcut
* Bottom panel widgets are not visible in zen mode
* Optional disabling of right panel in zen mode
#### Show Position in TOC and Syntax Highlight
Please go to each addon's respective page for instructions on how to enable these addons.
* [Show Position in TOC](https://github.com/SiriusXT/trilium-show-position-in-toc)
* [Syntax Highlight](https://github.com/antoniotejada/Trilium-SyntaxHighlightWidget)
## Credits and Resources
### Fonts
* Jost: https://indestructibletype.com/Jost.html