Skip to content

Commit

Permalink
docs: Fix syntax errors and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
elenapan authored and elkowar committed Jan 29, 2025
1 parent 2d7a8ac commit b83d7e8
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/src/conditional_templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ displays = ["eDP-1"]
# {% end %}
```

Note thta yolk added a special `<yolk>` prefix to the comments.
Note that yolk added a special `<yolk>` 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.

Expand Down
4 changes: 2 additions & 2 deletions docs/src/custom_template_functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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 {
Expand Down
6 changes: 3 additions & 3 deletions docs/src/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand All @@ -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 }
}
```

Expand Down
4 changes: 2 additions & 2 deletions docs/src/rhai_docs/global.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -4542,4 +4542,4 @@ print(z); // prints [10, 11, 12, 13]



</div>
</div>

0 comments on commit b83d7e8

Please sign in to comment.