mirrors/dotdrop
1
0
Fork 0
mirror of https://github.com/deadc0de6/dotdrop.git synced 2026-02-15 16:50:03 +00:00
Code Activity

Update links to jinja2 docs

Browse Source
This commit is contained in:
dotiful
2020-09-15 21:58:33 +03:00
parent 50b54171fd
commit 28568d80fd
7 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -27,7 +27,7 @@ a slightly different version of some of the dotfiles.
Features: Features:
* Sync once every dotfile on git for different usages * Sync once every dotfile on git for different usages
* Allow dotfiles templating by leveraging [jinja2](http://jinja.pocoo.org/) * Allow dotfiles templating by leveraging [jinja2](https://jinja.pocoo.org/)
* Dynamically generated dotfile contents with pre-defined variables * Dynamically generated dotfile contents with pre-defined variables
* Comparison between deployed and stored dotfiles * Comparison between deployed and stored dotfiles
* Handling multiple profiles with different sets of dotfiles * Handling multiple profiles with different sets of dotfiles

2
docs/README.md
View File

@@ -5,7 +5,7 @@ It is especially powerful when it comes to managing those across different hosts
The idea of dotdrop is to have the ability to store each dotfile only once and deploy them with a different The idea of dotdrop is to have the ability to store each dotfile only once and deploy them with a different
content on different hosts/setups. content on different hosts/setups.
To achieve this, it uses [jinja2](http://jinja.pocoo.org/) which is a templating engine that allows to specify To achieve this, it uses [jinja2](https://jinja.pocoo.org/) which is a templating engine that allows to specify
during the dotfile installation how (with what content) each dotfile will be installed based on a selected profile. during the dotfile installation how (with what content) each dotfile will be installed based on a selected profile.
Most information on using dotdrop are described in this documentation Most information on using dotdrop are described in this documentation

2
docs/howto/include-in-template.md
View File

@@ -1,6 +1,6 @@
# Include file or template in template # Include file or template in template
[Jinja2](http://jinja.pocoo.org/docs/2.10/templates/) provides the ability to include an external file/template from within a template with the directive `include`. See the [related doc](http://jinja.pocoo.org/docs/2.10/templates/#include) for more. The path must be relative to the `dotpath`. [Jinja2](https://jinja.palletsprojects.com/en/2.11.x/templates/) provides the ability to include an external file/template from within a template with the directive `include`. See the [related doc](https://jinja.palletsprojects.com/en/2.11.x/templates/#include) for more. The path must be relative to the `dotpath`.
For example: For example:
```yaml ```yaml

2
docs/howto/merge-files-when-installing.md
View File

@@ -49,7 +49,7 @@ Dotdrop will then automagically include the files into your vimrc when handling
To include all files in a directory, a combination of To include all files in a directory, a combination of
[dynvariables](../config-details.md#entry-dynvariables) [dynvariables](../config-details.md#entry-dynvariables)
and [jinja2 directives](http://jinja.pocoo.org/docs/2.10/) have to be used. and [jinja2 directives](https://jinja.palletsprojects.com/en/2.11.x/) have to be used.
Let's say all files in `<dotpath>/toinclude` need to be included into a dotfile. Let's say all files in `<dotpath>/toinclude` need to be included into a dotfile.

2
docs/howto/special-chars.md
View File

@@ -37,7 +37,7 @@ See <https://github.com/deadc0de6/dotdrop/issues/42>.
### Non-unicode chars ### Non-unicode chars
Jinja2 is not able to process non-unicode chars (<http://jinja.pocoo.org/docs/2.10/api/>). This means that dotfiles using non-unicode chars can still be fully managed by dotdrop however when comparing the local file with the one stored in dotdrop, `compare` will return a difference even if there is none. Jinja2 is not able to process non-unicode chars (<https://jinja.palletsprojects.com/en/2.11.x/api/>). This means that dotfiles using non-unicode chars can still be fully managed by dotdrop however when comparing the local file with the one stored in dotdrop, `compare` will return a difference even if there is none.
Either replace the non-unicode chars (see below [Re-encode](#re-encode)) or accept the fact the comparison shows a difference while there's none. Either replace the non-unicode chars (see below [Re-encode](#re-encode)) or accept the fact the comparison shows a difference while there's none.

14
docs/templating.md
View File

@@ -1,13 +1,13 @@
# Templating # Templating
Dotdrop leverage the power of [jinja2](http://jinja.pocoo.org/) to handle the Dotdrop leverage the power of [jinja2](https://jinja.pocoo.org/) to handle the
templating of dotfiles. See [jinja2 template doc](http://jinja.pocoo.org/docs/2.9/templates/) templating of dotfiles. See [jinja2 template doc](https://jinja.pocoo.org/docs/2.9/templates/)
or the below sections for more information on how to template your dotfiles. or the below sections for more information on how to template your dotfiles.
## Delimiters ## Delimiters
Dotdrop uses different delimiters than Dotdrop uses different delimiters than
[jinja2](http://jinja.pocoo.org/)'s defaults: [jinja2](https://jinja.pocoo.org/)'s defaults:
* block/statement start = `{%@@` * block/statement start = `{%@@`
* block/statement end = `@@%}` * block/statement end = `@@%}`
@@ -85,7 +85,7 @@ The above aliases load all the variables from `~/dotfiles/.env`
## Template methods ## Template methods
Beside [jinja2 global functions](http://jinja.pocoo.org/docs/2.10/templates/#list-of-global-functions) Beside [jinja2 global functions](https://jinja.pocoo.org/docs/2.11/templates/#list-of-global-functions)
the following methods can be used within the templates: the following methods can be used within the templates:
* `exists(path)`: return true when path exists * `exists(path)`: return true when path exists
@@ -140,7 +140,7 @@ this should exist
## Template filters ## Template filters
Beside [jinja2 builtin filters](https://jinja.palletsprojects.com/en/2.10.x/templates/#builtin-filters) Beside [jinja2 builtin filters](https://jinja.palletsprojects.com/en/2.11.x/templates/#builtin-filters)
custom user-defined filter functions can be loaded using the config entry `filter_file`: custom user-defined filter functions can be loaded using the config entry `filter_file`:
Example: Example:
@@ -163,7 +163,7 @@ dotfile content
``` ```
For more information on how to create filters, For more information on how to create filters,
see [jinja2 official doc](https://jinja.palletsprojects.com/en/2.10.x/api/#writing-filters). see [jinja2 official doc](https://jinja.palletsprojects.com/en/2.11.x/api/#writing-filters).
## Import macros ## Import macros
@@ -190,7 +190,7 @@ The header can be automatically added with:
``` ```
Properly commenting the header in templates is the responsibility of the user Properly commenting the header in templates is the responsibility of the user
as [jinja2](http://jinja.pocoo.org/) has no way of knowing what is the proper char(s) used for comments. as [jinja2](https://jinja.pocoo.org/) has no way of knowing what is the proper char(s) used for comments.
Either prepend the directive with the commenting char(s) used in the dotfile Either prepend the directive with the commenting char(s) used in the dotfile
(for example `# {{@@ header() @@}}`) or provide it as an argument `{{@@ header('# ') @@}}`. (for example `# {{@@ header() @@}}`) or provide it as an argument `{{@@ header('# ') @@}}`.
The result is equivalent. The result is equivalent.

2
docs/usage.md
View File

@@ -121,7 +121,7 @@ f_dunstrc (file: "config/dunst/dunstrc", link: nolink)
``` ```
By using the `-T --template` switch, only the dotfiles that By using the `-T --template` switch, only the dotfiles that
are using [jinja2](http://jinja.pocoo.org/) directives are listed. are using [jinja2](https://jinja.pocoo.org/) directives are listed.
It is also possible to list all files related to each dotfile entries It is also possible to list all files related to each dotfile entries
by invoking the `detail` command, for example: by invoking the `detail` command, for example: