dakedres/shchemes
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fully documented!

Browse Source
This commit is contained in:
Dakedres
2024-04-01 10:08:49 -06:00
parent 2ba4061454
commit 71f922de59
4 changed files with 87 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
doc/manual.md
View File

@@ -50,7 +50,7 @@ shchemes create_theme alacritty --format=base24
## METHODS
## create_theme
## create_theme {#create_theme}
Apply the color scheme to the template for a given app
```
@@ -66,7 +66,9 @@ In the given file, looks for a comment that indicates a Shchemes injection block
shchemes inject PATH
```
## install_tinted_scheme
See also: [`create_theme`](#create_theme)
## install_tinted_scheme {#install_tinted_scheme}
Installs a color scheme from the [tinted-theming/schemes](https://github.com/tinted-theming/schemes).
You can find a gallery of the base16 themes here:
@@ -75,7 +77,40 @@ You can find a gallery of the base16 themes here:
shchemes install_tinted_scheme
```
See also: [`SCHEME`](#SCHEME) [`--scheme`](#scheme)
See also: [`SCHEME`](#SCHEME) [`--scheme`](#scheme) [`convert_tinted_scheme`](#convert_tinted_scheme)
## convert_tinted_scheme {#convert_tinted_scheme}
Converts a tinted-theming scheme to a .properties format for use in shchemes.
```
shchemes convert_tinted_scheme pico.yaml
cat pico.yaml > shchemes convert_tinted_scheme
```
See also: [`install_tinted_scheme`](#install_tinted_scheme)
## install_tinted_template {#install_tinted_template}
Downloads, converts, and installs a tinted-theming template from a given url.
```
shchemes install_tinted_template https://raw.githubusercontent.com/tinted-theming/base16-emacs/main/templates/default.mustache
```
It is recommended that you use already-maintained shchemes templates rather than just installing and converting third party ones.
See also: [`convert_tinted_template`](#convert_tinted_template)
## convert_tinted_template {#convert_tinted_template}
Converts a tinted-theming .mustache template to a shchemes template.
```
shchemes convert_tinted_template default.mustache > ~/shchemes/base16/templates/emacs.mustache
```
See also: [`install_tinted_template`](#install_tinted_template)
## manual, man, help
Opens this manual
# AUTHOR