hiro/tridactyl
1
0
Fork 0
mirror of https://github.com/vale981/tridactyl synced 2025-03-06 01:51:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Tidy autocontain docs

Browse source
This commit is contained in:
Oliver Blanthorn 2019-10-17 22:05:13 +01:00
parent fec571d748
commit 308ac0a043
No known key found for this signature in database
GPG key ID: 2BB8C36BB504BFF3
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/excmds.ts
View file

@ -3316,12 +3316,13 @@ export function autocmd(event: string, url: string, ...excmd: string[]) {
config.set("autocmds", event, url, excmd.join(" "))
}
/** Automatically open a domain and all its subdomains in a specified container.
/**
* Automatically open a domain and all its subdomains in a specified container.
*
* For declaring containers that do not yet exist, consider using `auconscreatecontainer true` in your tridactylrc.
* This allows tridactyl to automatically create containers from your autocontain directives. Note that they will be random icons and colors.
*
* ** NB: This is an experimental feature, if you encounter issues please create an issue on github. **
* __NB: This is an experimental feature, if you encounter issues please create an issue on GitHub.__
*
* The domain is passed through as a regular expression so there are a few gotchas to be aware of:
* * Unescaped periods will match *anything*. `autocontain google.co.uk work` will match `google!co$uk`. Escape your periods or accept that you might get some false positives.
@ -3331,6 +3332,7 @@ export function autocmd(event: string, url: string, ...excmd: string[]) {
*
* @param domain The domain which will trigger the autoContain directive. Includes all subdomains.
* @param container The container to open the url in.
*
*/
//#background
export function autocontain(domain: string, container: string) {