Edit README

This commit is contained in:
lolabird 2025-04-07 21:47:08 -06:00
commit d2a61d235e
No known key found for this signature in database
GPG key ID: CCB68A8A3FA20AAA
3 changed files with 24 additions and 13 deletions

View file

@ -1,7 +1,7 @@
# Stellar Dark Theme
Dark theme for [Trilium Notes](https://github.com/zadam/trilium)
Dark theme for [Trilium Notes](https://github.com/zadam/trilium) and [TriliumNext](https://github.com/TriliumNext/Notes)
![Text Showcase](/screenshots/SD_Main.png)
![Text Showcase](/screenshots/StellarDark_main.png)
## Features
### Native Styles
@ -9,32 +9,41 @@ Dark theme for [Trilium Notes](https://github.com/zadam/trilium)
* High contrast
* Scrolling tables with sticky headers on both axes
* Vertical floating buttons that have much less overlap with content of notes
* Different styles to distinguish between different types of links
* Custom fonts
* Bright colors
### Enhanced Addon Styles
*See 'Usage Instructions' for information on how to enable these.*
* Zen Mode
* Matching syntax highlight in text notes
_See 'Usage Instructions' for information on how to enable these.*_
* Zen mode (with right panel enabled)*
* Matching code note and code block syntax highlight*
* Position shown in TOC
* And much more!
_*If you are using TriliumNext, zen mode and code block syntax highlight are already natively available in the application. No extra steps are required for these addons unless you want to disable the right panel in zen mode. Please see the usage instructions below if this is the case._
## Usage Instructions
### Installation
* Download the latest version of Trilium
* Download the latest release of Stellar Dark
* Download and install the latest version of Trilium or TriliumNext
* Download the latest release of EverForest Ant Dark
* OG_StellarDark if you use the original Trilium Notes
* Next_StellarDark if you use TriliumNext
* 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 Stellar Dark
* 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
* Add the following code (created by [Nriver](https://github.com/Nriver/awesome-trilium/issues/44)) to the note:
```js
api.addButtonToToolbar({
title: 'Zen mode',
@ -45,10 +54,10 @@ Dark theme for [Trilium Notes](https://github.com/zadam/trilium)
shortcut: 'alt+z'
});
```
* Reload (`ctrl+r` or `F5`) Trilium to enable the script
* Reload (<kbd>ctrl+r</kbd> or <kbd>F5</kbd>) 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.
Press <kbd>alt+z</kbd> 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
@ -66,11 +75,13 @@ Right panel is enabled by default. If you would like to disable it, you can eith
https://github.com/user-attachments/assets/189e35e4-2ba0-4e93-b6cb-1dd25e0cd523
##### 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
* 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
_*Natively available in TriliumNext_
#### 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)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 300 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 279 KiB