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

documentation

Browse Source
This commit is contained in:
deadc0de6
2022-05-04 23:30:37 +02:00
committed by deadc0de
parent 3dfa53469e
commit 2dd045097f
3 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -37,7 +37,7 @@ a slightly different version of some of the dotfiles.
Features: Features:
* Sync once every dotfile in Git for different usages * Sync once every dotfile in Git for different usages
* Allow dotfile templating by leveraging [Jinja2](https://palletsprojects.com/p/jinja/) * Allow dotfile templating
* 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

11
docs/README.md
View File

@@ -1,12 +1,11 @@
# Dotdrop # Dotdrop
[Dotdrop](https://deadc0de.re/dotdrop/) is a dotfiles manager that provides efficient ways to manage your dotfiles. [Dotdrop](https://deadc0de.re/dotdrop/) is a dotfiles manager that provides efficient
It is especially powerful when it comes to managing them across different hosts. ways to manage your dotfiles.
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 different The idea of dotdrop is to have the ability to store each dotfile only once and deploy
content on different hosts/setups. them with different content on different hosts/setups.
To achieve this, it uses [Jinja2](https://palletsprojects.com/p/jinja/), which is a templating engine that allows you to specify
during the dotfile installation how (with what content) each dotfile will be installed based on a selected profile.
Most information on using dotdrop is described in this documentation Most information on using dotdrop is described in this documentation
and in the [readme](https://github.com/deadc0de6/dotdrop/blob/master/README.md). and in the [readme](https://github.com/deadc0de6/dotdrop/blob/master/README.md).

2
docs/config-details.md
View File

@@ -203,7 +203,7 @@ There are two types of transformations available:
* They have two arguments: * They have two arguments:
* **{0}** will be replaced with the dotfile to process * **{0}** will be replaced with the dotfile to process
* **{1}** will be replaced with a temporary file to store the result of the transformation * **{1}** will be replaced with a temporary file to store the result of the transformation
* Happens **before** the dotfile is templated with Jinja2 (see [templating](templating.md)) * This Happens **before** the dotfile is templated (see [templating](templating.md))
* **Write transformations**: used to transform files before updating a dotfile ([format](config-format.md) key `trans_write`) * **Write transformations**: used to transform files before updating a dotfile ([format](config-format.md) key `trans_write`)
* Used for command `update` * Used for command `update`