everforest-ant-dark-trilium.../README.md

124 lines
4.9 KiB
Markdown
Raw Normal View History

2024-08-26 13:35:45 -06:00
# EverForest Ant Dark (EFAD) Trilium Theme
2024-10-12 00:19:55 -06:00
This is a [Trilium Notes](https://github.com/zadam/trilium) theme to go with Everforest and Ant Dark Linux desktop themes.
![Text Showcase](/screenshots/EFAD_Main.png)
2024-08-26 13:28:00 -06:00
2024-10-12 00:22:35 -06:00
## Features
### Native Styles
* Dark theme
* High contrast
* Scrolling tables with sticky headers on both axes
* Vertical floating buttons that have much less overlap with content of notes
* Custom fonts
* Earthy colors
### Enhanced Addon Styles
*See 'Usage Instructions' for information on how to enable these.*
* Zen Mode
* Matching syntax highlight in text notes
* Position shown in TOC
* And much more!
## Usage Instructions
* Download the latest version of Trilium
* Download the latest release of EverForest Ant Dark
* In your trilium instance right click a note you want to import the theme into
* Select "Import into note" in the context menu
* Uncheck "Safe import" and upload the zip file you just downloaded
* Click on the Trilium logo in the upper left corner and select Options -> Appearance
* Under "Theme", choose EverForest Ant Dark
* Enjoy!
2024-10-12 00:24:59 -06:00
### 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.
2024-10-12 01:44:37 -06:00
```css
/*hide right pane*/
.zen-mode #right-pane {
display: none !important;
}
```
https://github.com/user-attachments/assets/cec5564d-07f4-405e-85f7-b998d85a277c
2024-10-12 00:24:59 -06:00
##### 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)
2024-10-12 00:35:34 -06:00
## Screenshots and Videos
![Selection Showcase](/screenshots/EFAD_Hover.png)
2024-10-12 00:24:59 -06:00
https://github.com/user-attachments/assets/af52206b-1c09-4567-9bbd-553b96f33c66
2024-08-26 13:28:00 -06:00
2024-10-12 00:35:34 -06:00
![Map Showcase](/screenshots/EFAD_Map.png)
2024-10-12 00:35:34 -06:00
![Code Showcase](/screenshots/EFAD_Code.png)
https://github.com/user-attachments/assets/b04401cf-7579-4abc-bfc2-a91d69cfd971
2024-10-12 00:35:34 -06:00
![Text Note Syntax Highlight Showcase](/screenshots/EFAD_Highlight.png)
2024-08-26 13:35:45 -06:00
2024-10-12 01:19:18 -06:00
## Credits and Resources
### Fonts
2024-10-12 16:58:47 -06:00
* Jost: https://indestructibletype.com/Jost.html
* JetBrainsMono: https://www.jetbrains.com/lp/mono/
2024-10-12 01:19:18 -06:00
### Desktop Themes
#### Ant Dark
2024-10-12 16:58:47 -06:00
* KDE: https://store.kde.org/p/1464285/
* GitHub: https://github.com/EliverLara/Ant/tree/master/kde/Dark
2024-10-12 01:19:18 -06:00
2024-08-26 13:28:00 -06:00
#### EverForest
2024-08-26 13:38:47 -06:00
*Note: There are several EverForest Firefox themes, but the one I personally like and use is listed below.*
2024-08-26 13:28:00 -06:00
2024-08-26 13:35:45 -06:00
* Gnome: https://www.gnome-look.org/p/1695467
* GitHub (Gnome): https://github.com/Fausto-Korpsvart/Everforest-GTK-Theme
2024-08-26 13:35:45 -06:00
* Firefox: https://addons.mozilla.org/en-US/firefox/addon/everforest_theme/
#### Zafiro Icon Theme
*Note: I only have GitHub and KDE listed below, but this set is also available for other desktop environments as well.*
* GitHub: https://github.com/zayronxio/Zafiro-icons
* KDE: https://store.kde.org/p/1209330
### Addons Featured in the Screenshots and Videos
* [Breadcrumbs](https://github.com/rauenzi/Trilium-Breadcrumbs)
* [Scratchpad](https://github.com/zadam/trilium/discussions/1613#discussioncomment-638984)
* [Show Position in TOC](https://github.com/SiriusXT/trilium-show-position-in-toc)
* [Syntax Highlight](https://github.com/antoniotejada/Trilium-SyntaxHighlightWidget)
* [Theme Switch](https://github.com/madodig/trilium-widget-theme-switch)
* [Trilium Chat](https://github.com/soulsands/trilium-chat)
* WordCount (Featured in the [Demo Document](https://github.com/zadam/trilium/wiki/Document#demo-document))
* [Zen Mode](https://github.com/Nriver/awesome-trilium/issues/44)
2024-10-12 02:52:16 -06:00
Find more addons made by the Trilium community at [Nriver's Awesome Trilium](https://github.com/Nriver/awesome-trilium?tab=readme-ov-file#%EF%B8%8F-widgets), and check out my other theme [Stellar Dark](https://github.com/Lolabird/stellar-dark-theme-trilium) while you're at it!!