docs: update doc

Author: oknozor

website/content/docs/config-import/import.md

@@ -23,7 +23,6 @@ top = false
 Instead of having all your configs defined in a single toml file, you can split it into multiple file :
 
 ```toml
-
 [settings.dots]
 alacritty = { source = "alacritty", target = ".config/alacritty" }
 zsh = { source = "zsh/zshrc", target = ".zshrc" }
@@ -35,6 +34,21 @@ path = "sway/sway.toml"
 path = "i3/i3.toml"
 ```
 
+Alternatively you can define multiple imports at once: 
+```toml
+dotfiles_dir = "dotfiles"
+
+import = [
+  { path = "sway/sway.toml" },
+  { path = "i3/i3.toml" },
+]
+
+[settings.dots]
+alacritty = { source = "terminals/alacritty", target = ".config/alacritty" }
+zsh = { source = "zsh/zshrc", target = ".zshrc" }
+# ...
+```
+
 In this example we have defined our `i3` and `sway` profile in separate files :
 
 ```toml

website/content/docs/getting-started/quick-start.md

@@ -92,6 +92,8 @@ Once you are satisfied with your config, you can install your dotfiles:
 bombadil link
 ```
 
+Alternatively you can use `bombadil watch` to continuously render templates while editing.
+
 ### Clean up
 
 If you want to remove symlinks generated by Toml Bombadil run the following:

website/content/docs/hooks/hooks.md

@@ -41,15 +41,21 @@ per profile hooks :
 
 ```toml
 [settings]
-prehooks = [ "echo \"Updating dots\""]
-posthooks = [ "echo \"Default profile\"" ]
+prehooks = [ "echo 'Updating dots'"]
+posthooks = [ "echo 'Default profile'" ]
 
 [profiles.sway]
-prehooks = [ "echo \"Sway profile\"" ]
+# Use toml multiline string to escape quotes and special characters
+prehooks = [ 
+  """
+  echo "Sway profile"
+  """ 
+]
+
 posthooks = [ "sway reload" ]
 
 [profiles.i3]
-prehooks = [ "echo \"i3 profile\"" ]
+prehooks = [ "echo 'i3 profile'" ]
 posthooks = [ "i3-msg reload" ]
 ```
 
@@ -61,14 +67,4 @@ posthooks = [ "i3-msg reload" ]
 posthooks = [ "source /home/user/.zshrc" ] # This does not work !
 ```
 
-- Environment variables won't be expanded unless you explicitly call a sub-shell :
-
-```toml
-posthooks = [ "echo $HOME" ] # This will print "$HOME"
-```
-
-```toml
-posthooks = [ "zsh -c \"echo $HOME\"" ] # This works
-```
-
 That's it for hooks, in the next chapter we will see how to split your Bombadil config into multiple files.

website/content/docs/profiles-and-themes/profile-variables.md

@@ -21,15 +21,14 @@ Let's assume you have the following in your `.bashrc` dotfile:
 ```bash
 # ~/bombadil-example/bashrc
 export JAVA_HOME={{java_home}}
-# ...
 ```
 
 And your default profiles variable look like this:
 
 ```toml
 # ~/bombadil-example/vars.toml
-java_home = "/etc/java-openjdk"
-# ...
+[java]
+home = "/etc/java-openjdk"
 ```
 
 Here is our bombadil config:
@@ -40,7 +39,7 @@ dotfile_dir = "bombadil-example"
 vars = [ "vars.toml" ]
 
 [settings.dots]
-bashrc = { source = "bashrc", target = ".bashrc"}
+bashrc = { source = "bashrc", target = ".bashrc" }
 ```
 
 So far we have defined a variable for `$JAVA_HOME` and we are using it once.
@@ -57,7 +56,7 @@ dotfile_dir = "bombadil-example"
 vars = [ "vars.toml" ]
 
 [settings.dots]
-bashrc = { source = "bashrc", target = ".bashrc"}
+bashrc = { source = "bashrc", target = ".bashrc" }
 
 [profiles.corporate]
 vars = [ "java10-vars.toml" ]
@@ -66,8 +65,8 @@ vars = [ "java10-vars.toml" ]
 The profile variable file will be loaded after the default one and any matching variable name will override the default:
 
 ```toml
-java_home = "/etc/java10-openjdk"
-# ...
+[java]
+home = "/etc/java10-openjdk"
 ```
 
 Running `bombadil link -p corporate` would now produce the following `.bashrc` :

website/content/docs/profiles-and-themes/profiles-overrides.md

@@ -56,13 +56,15 @@ Notice on the `corporate` profile we are redefining the `maven` dot entry and on
 Linking the default profile with `bombadil link`, will produce the following link :
 ```bash
 bombadil link
+[Created]
 "/home/okno/dotfiles/.dots/maven/settings.xml" => "/home/okno/.m2/settings.xml"
 ```
 
 Linking with the `corporate` profile will use the alternate source for `.m2/settings.xml` :
 
 ```bash
 bombadil link -p corporate
+[Created]
 "/home/okno/dotfiles/.dots/maven/settings.corporate.xml" => "/home/okno/.m2/settings.xml"
 ```
 

website/content/docs/profiles-and-themes/profiles.md

@@ -17,7 +17,7 @@ top = false
 ## Profile configuration
 
 As we saw Bombadil allows to define a default profile. For some programs you might want to
-set an alternate configuration.
+set alternative configurations.
 
 Bombadil allow you two do this in several ways :
 - override dot entries `source` and/or `target` value.

website/content/docs/template-and-variables/variable-references.md

@@ -1,73 +0,0 @@
-+++
-title = "Variable reference"
-description = "Manage variable reference"
-date = 2021-05-16
-updated = 2021-05-16
-draft = false
-weight = 2
-sort_by = "weight"
-template = "docs/page.html"
-
-[extra]
-lead = """
-Variable references allows using different variable names for the same values.
-Define system wide color schemes, global values for specific environments etc.
-"""
-toc = true
-top = false
-+++
-
-### Declare variable references
-
-A variable reference is declared like any other variable, except the value should be a variable name prefixed with `%`.
-
-```toml
-a_variable = "42"
-variable_ref = "%a_variable"
-```
-
-Here `%a_variable` points to `"42"`. Any template call to `{{variable_ref}}` will be replace by `42` when running
-`bombadil link`.
-
-### Layout example
-
-The main idea behind variable references is to avoid repetition and inject values into multiple dotfiles.
-As you will see later in this documentation, references are meant to be mixed with profiles and scoped variable.
-
-For now let us define a simple layout. Assuming we are using sway as a window manager, and our terminal is alacritty, 
-we are going to define three separate variables files : 
-- A global variable file `theme_vars.toml`
-- A variable file for alacritty `alacritty_vars.toml`
-- A variable file for sway `sway_vars.toml`
-
-```toml
-# bombadil.toml
-[settings]
-vars = [ "theme_vars.toml", "alacritty_vars.toml", "sway_vars.toml" ]
-# ... 
-```
-
-- `theme_vars.toml` contains all our system theme colors : 
-
-    ```toml
-    red = "#ff0000"
-    black = "#000000"
-    green = "#008000"
-    ```
-- `sway_vars.toml` contain sway specific variables, some are references, some are static. 
-    ```toml
-    sway_client_focused_background = "%black"
-    sway_client_focused_border = "#ffff00"
-    # ...
-    ```
-
-- `alacritty_vars.toml` uses references just like sway variables.
-
-    ```toml
-    alacritty_background = "%black"
-    alacritty_cursor = "%green"
-    # ...
-    ```
-
-In the next section we will see how to scope variables to a specific dot entry. 
-

website/content/docs/template-and-variables/variable-scope.md

@@ -18,7 +18,7 @@ toc = true
 top = false
 +++
 
-### Variable scopes
+### Variable collocation
 
 By default, bombadil will look for a file named `vars.toml` in every dotfile entry source directory : 
 
@@ -44,16 +44,14 @@ wofi = { source = "wofi", target = ".config/wofi" }
 And some variables defined in `wofi/vars.toml` :
 
 ```toml
-# Here we use variable references from `theme.toml`
-bg = "%blue"
-input_bg = "%white"
-input_color = "%light_blue"
-input_focused_bg = "%blue"
+[colors]
+gb = "#292C3E"
+input_bg = "#EBEBEB"
+input_color = "#FF261E"
+input_focused_bg = "#FF261E"
 ```
 
-Running `bombadil link` will render variables defined in `wofi/vars.toml` only for templates that resides in `wofi/`.
-
-### Explicitly declare scoped variables
+### Explicitly declare variable collocation
 
 The previous example works fine as long as our dotfile source is a directory.
 Indeed, Bombadil will look for a variable file named `vars.toml` in the source directory and everything will be rendered

website/content/docs/template-and-variables/variables.md

@@ -35,12 +35,16 @@ vars = [ "colors.toml", "env_vars.toml" ]
 
 ### Declare variables
 
-A Bombadil var files is a toml file containing key with string values only.
+A Bombadil var files is a normal toml file.  
 
 For example, you have the following file in `{dotfiles_dir}/vars.toml`.
 
 ```toml
+[apps]
 terminal = "alacritty"
+bar = "waybar"
+
+[theme.colors]
 background = "#292C3E"
 foreground = "#EBEBEB"
 text = "#FF261E"
@@ -51,8 +55,8 @@ green = "#A0E521"
 yellow = "#FFC620"
 blue = "#1BA6FA"
 
-# A flag to conditionally include some block of configuration.
-set_cursor_color = "true"
+[theme.settings]
+set_cursor_color = true
 ```
 
 Given the following dot entry : 
@@ -65,15 +69,14 @@ The `source` attributes point to a template dotfile named `alacritty.yaml`.
 We can use the previously defined variables using the `{{variable_name}}` syntax :
 
 ```yaml
-# {dotfiles}/alacritty.yml
 colors:
    primary:
-       background: "{{background}}"
-       foreground: "{{foreground}}"
-{%- if set_cursor_color == "true" %}
+       background: "{{theme.colors.background}}"
+       foreground: "{{theme.colors.foreground}}"
+{%- if theme.settings.set_cursor_color == "true" %}
    cursor:
-       text: "{{text}}"
-       cursor: "{{cursor}}"
+       text: "{{theme.colors.text}}"
+       cursor: "{{theme.colors.cursor}}"
 {% endif -%}
 ```
 
@@ -86,16 +89,13 @@ Templates will be rendered to the `.dots` directory, then symlinked according to
 In the previous example the output file actually linked to alacritty's config would look like this:
 
 ```yaml
-...
-# {dotfiles}/.dots/alacritty.yml
 colors:
   primary:
     background: "#292C3E"
     foreground: "#EBEBEB"
   cursor:
     text: "#FF261E"
     cursor: "#FF261E"
-# ...
 ```
 
 In the next section we will see how to organize our variables to make reusable structured themes using variable references. 

website/static/processed_images/48de334e2eeae67200.png

@@ -29,7 +29,7 @@
 {{ macros_head::favicons() }}
 {% block math %}{{ macros_math::math() }}{% endblock math %}
 </head>
-{% block body %}{% set page_class="home dark" %}{% endblock body %}
+{% block body %}{% set page_class="home" %}{% endblock body %}
 <body class="{{ page_class }}">
   {% block header %}
     {{ macros_header::header(current_section="/") }}