Improve guiset documentation

This commit is contained in:
Oliver Blanthorn 2018-05-05 13:06:49 +01:00
parent 81613c9c42
commit 0cc08acd8e
No known key found for this signature in database
GPG key ID: 2BB8C36BB504BFF3
2 changed files with 33 additions and 1 deletions

View file

@ -1,5 +1,12 @@
# Tridactyl changelog # Tridactyl changelog
## Release 1.11.0 / Unreleased
- You can now edit the Firefox GUI from Tridactyl with `guiset`. You must restart Firefox after using `guiset` to see the effects.
- e.g, `guiset gui none` or `guiset gui full`.
- see all the options with `help guiset` and following the links.
- **Only minimally tested. Back up your precious userChrome.css if you care about it!**
## Release 1.10.1 / 2018-05-04 ## Release 1.10.1 / 2018-05-04
- Add tabcloseallto{right,left} bound to `gx0` and `gx$` - Add tabcloseallto{right,left} bound to `gx0` and `gx$`

View file

@ -178,7 +178,7 @@ export async function editor() {
import * as css_util from "./css_util" import * as css_util from "./css_util"
/** /**
* Change which parts of the Firefox user interface are shown. * Change which parts of the Firefox user interface are shown. **NB: This feature is experimental and might break stuff.**
* *
* Might mangle your userChrome. Requires native messenger, and you must restart Firefox each time to see any changes. <!-- (unless you enable addon debugging and refresh using the browser toolbox) --> * Might mangle your userChrome. Requires native messenger, and you must restart Firefox each time to see any changes. <!-- (unless you enable addon debugging and refresh using the browser toolbox) -->
* *
@ -186,6 +186,31 @@ import * as css_util from "./css_util"
* *
* Example usage: `guiset gui none`, `guiset gui full`, `guiset tabs autohide`. * Example usage: `guiset gui none`, `guiset gui full`, `guiset tabs autohide`.
* *
* Some of the available options:
*
* - gui
* - full
* - none
*
* - tabs
* - always
* - autohide
*
* - navbar
* - always
* - autohide
*
* - hoverlink (the little link that appears when you hover over a link)
* - none
* - left
* - right
* - top-left
* - top-right
*
* - titlebar
* - hide
* - show
*
*/ */
//#background //#background
export async function guiset(rule: string, option: string) { export async function guiset(rule: string, option: string) {