diff --git a/docs/src/conditional_templates.md b/docs/src/conditional_templates.md index d02c815..8bb720e 100644 --- a/docs/src/conditional_templates.md +++ b/docs/src/conditional_templates.md @@ -37,7 +37,7 @@ displays = ["eDP-1"] # {% end %} ``` -Note thta yolk added a special `` prefix to the comments. +Note that yolk added a special `` prefix to the comments. Yolk conditionals will only ever add or remove comments with this prefix, which means that you can still have regular comments in those conditional blocks. diff --git a/docs/src/custom_template_functions.md b/docs/src/custom_template_functions.md index e12e8e4..7495c90 100644 --- a/docs/src/custom_template_functions.md +++ b/docs/src/custom_template_functions.md @@ -5,7 +5,7 @@ The answer is YES! ## How do template tag functions work -Template tag functions are executed in a special context, in which a function called `get_yolk_text()` is availale. +Template tag functions are executed in a special context, in which a function called `get_yolk_text()` is available. This variable contains the text block that the template tag operates on. A template tag function then returns a string which yolk will replace the old text block with. @@ -14,7 +14,7 @@ A template tag function then returns a string which yolk will replace the old te Let's define a simple, useless template tag function in your `yolk.rhai`. ```rust,ignore -fn scream_or_not(should_scream) +fn scream_or_not(should_scream) { if should_scream { get_yolk_text().to_upper() } else { diff --git a/docs/src/getting_started.md b/docs/src/getting_started.md index af0ea89..15f8296 100644 --- a/docs/src/getting_started.md +++ b/docs/src/getting_started.md @@ -15,7 +15,7 @@ Yolk groups dotfiles into so-called ["eggs"](eggs.md), which are packages of con typically for one single application (although you can group them however you want, or even just have one egg for all your configuration files). When an egg is "deployed", Yolk creates symlinks in the target location pointing towards the egg directory. -This way, the configured appliactions will see the configuration files as they expect to see them. +This way, the configured applications will see the configuration files as they expect to see them. To define where a set of configuration files should be deployed to, you declare each of your eggs in your [main yolk configuration file](./yolk_rhai.md). This allows you, among other things, to define a different target directory per system. @@ -66,7 +66,7 @@ $ yolk git add --all $ yolk git commit -m "Setup alacritty" ``` -You can now set up your git reomte and use git as usual. +You can now set up your git remote and use git as usual. ### Baby's first template @@ -91,7 +91,7 @@ const themes = #{ } export const data = #{ - colors = if SYSTEM.hostname == "laptop" { themes.gruvbox } else { themes.mono } + colors: if SYSTEM.hostname == "laptop" { themes.gruvbox } else { themes.mono } } ``` diff --git a/docs/src/rhai_docs/global.md b/docs/src/rhai_docs/global.md index d8e94a5..85fa149 100644 --- a/docs/src/rhai_docs/global.md +++ b/docs/src/rhai_docs/global.md @@ -3,7 +3,7 @@ # Rhai Standard Library builtins Rhai standard library functions. -Note that the typesignatures here do look a bit weird. +Note that the type signatures here do look a bit weird. This is simply a result of how we generate the documentation, and can't easily be improved. @@ -4542,4 +4542,4 @@ print(z); // prints [10, 11, 12, 13] - \ No newline at end of file +