mirror of
https://github.com/Lolabird/stellar-dark-theme-trilium.git
synced 2026-10-18 19:16:58 -06:00
Add features and main/zen mode usage instructions
This commit is contained in:
parent
df7873c400
commit
871315857e
7 changed files with 48 additions and 5 deletions
53
README.md
53
README.md
|
|
@ -1,7 +1,22 @@
|
||||||
# Stellar Dark Theme
|
# Stellar Dark Theme
|
||||||
Dark theme for Trilium Notes (https://github.com/zadam/trilium)
|
Dark theme for [Trilium Notes](https://github.com/zadam/trilium)
|
||||||
|
|
||||||
|
## Features
|
||||||
|
### Native Styles
|
||||||
|
* High contrast
|
||||||
|
* Scrolling tables with sticky headers on both axes
|
||||||
|
* Vertical floating buttons that have much less overlap with content of notes
|
||||||
|
* Bright 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
|
## Usage Instructions
|
||||||
|
### Installation
|
||||||
* Download the latest version of Trilium
|
* Download the latest version of Trilium
|
||||||
* Download the latest release of Stellar Dark
|
* Download the latest release of Stellar Dark
|
||||||
* In your trilium instance right click a note you want to import the theme into
|
* In your trilium instance right click a note you want to import the theme into
|
||||||
|
|
@ -11,10 +26,38 @@ Dark theme for Trilium Notes (https://github.com/zadam/trilium)
|
||||||
* Under "Theme", choose Stellar Dark
|
* Under "Theme", choose Stellar Dark
|
||||||
* Enjoy!
|
* 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]) 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 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.
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
## Screenshots and Videos
|
## Screenshots and Videos
|
||||||

|

|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
## Credits and Resources
|
## Credits and Resources
|
||||||
### Fonts
|
### Fonts
|
||||||
|
|
@ -30,4 +73,4 @@ Dark theme for Trilium Notes (https://github.com/zadam/trilium)
|
||||||
* WordCount (Featured in the [Demo Document](https://github.com/zadam/trilium/wiki/Document#demo-document))
|
* 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)
|
* [Zen Mode](https://github.com/Nriver/awesome-trilium/issues/44)
|
||||||
|
|
||||||
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)!
|
Find more addons made by the Trilium community at [Nriver's "Awesome Trilium" page](https://github.com/Nriver/awesome-trilium?tab=readme-ov-file#%EF%B8%8F-widgets)!
|
||||||
|
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 158 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 142 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 301 KiB |
Loading…
Reference in a new issue