mirror of
https://github.com/deadc0de6/dotdrop.git
synced 2026-02-04 19:44:45 +00:00
doc update doc
This commit is contained in:
@@ -34,4 +34,4 @@
|
||||
|
||||
## Symlink dotfiles
|
||||
|
||||
[Symlink dotfiles](symlinked-dotfiles.md)
|
||||
[Symlink dotfiles](symlink-dotfiles.md)
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
Sometimes it might be useful to be able to append some text to a
|
||||
file. Dotdrop is able to do that with the help of
|
||||
[actions](../config.md#actions).
|
||||
and a temporary file.
|
||||
[actions](../config.md#entry-actions) and a temporary file.
|
||||
|
||||
Below is a config example to append to a file:
|
||||
```yaml
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
One way for creating symlinks (or any other special files) is to use a combination of
|
||||
[actions](../config.md#actions) and a *fake* dotfile.
|
||||
[actions](../config.md#entry-actions) and a *fake* dotfile.
|
||||
|
||||
Let's say for example you have a list of directories you want to link
|
||||
from under `~/.original` to `~/symlinks`.
|
||||
@@ -19,6 +19,7 @@ dir3
|
||||
```
|
||||
|
||||
The config file would contain different elements
|
||||
|
||||
* a `dynvariables` that will read the above text file
|
||||
* a few `variables` for the source and destination
|
||||
* an action that will create the destination directory and symlink those directories
|
||||
|
||||
@@ -46,12 +46,12 @@ Dotdrop will then automagically include the files into your vimrc when handling
|
||||
# Merge all files in a directory
|
||||
|
||||
To include all files in a directory, a combination of
|
||||
[dynvariables](../config.md#interpreted-variables)
|
||||
[dynvariables](../config.md#entry-dynvariables)
|
||||
and [jinja2 directives](http://jinja.pocoo.org/docs/2.10/) have to be used.
|
||||
|
||||
Let's say all files in `<dotpath>/toinclude` need to be included into a dotfile.
|
||||
|
||||
First define a [dynvariables](../config.md#interpreted-variables)
|
||||
First define a [dynvariables](../config.md#entry-dynvariables)
|
||||
in the config file which will look for files to include in the above directory:
|
||||
```yaml
|
||||
dynvariables:
|
||||
|
||||
@@ -1,16 +1,11 @@
|
||||
# Sensitive dotfiles
|
||||
|
||||
* [Available solutions](#available-solutions)
|
||||
* [Store encrypted dotfiles](#store-encrypted-dotfiles)
|
||||
* [Load passphrase from file](#load-passphrase-from-file)
|
||||
|
||||
---
|
||||
|
||||
# Available solutions
|
||||
|
||||
Two solutions exist, the first one using an unversioned file (see [Environment variables](../templating.md#environment-variables))
|
||||
and the second using transformations (see [Store encrypted dotfiles](#store-encrypted-dotfiles)).
|
||||
|
||||
* [Store encrypted dotfiles](#store-encrypted-dotfiles)
|
||||
* [Load passphrase from file](#load-passphrase-from-file)
|
||||
|
||||
# Store encrypted dotfiles
|
||||
|
||||
Here's an example of part of a config file to use gpg encrypted dotfiles:
|
||||
|
||||
@@ -31,15 +31,15 @@ This is due to Jinja2 stripping CRLF.
|
||||
|
||||
One solution is to use `dos2unix` to re-format the dotfiles before adding them to dotdrop.
|
||||
|
||||
See https://github.com/deadc0de6/dotdrop/issues/42.
|
||||
See <https://github.com/deadc0de6/dotdrop/issues/42>.
|
||||
|
||||
## 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 (<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.
|
||||
|
||||
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.
|
||||
|
||||
See https://github.com/deadc0de6/dotdrop/issues/42.
|
||||
See <https://github.com/deadc0de6/dotdrop/issues/42>.
|
||||
|
||||
# Re-encode
|
||||
|
||||
|
||||
@@ -13,11 +13,6 @@ Note that if the dotfile is using template directives, it will be symlinked into
|
||||
`~/.config/dotdrop` instead of directly into your *dotpath*
|
||||
(see [Templating symlinked dotfiles](#templating-symlinked-dotfiles))
|
||||
|
||||
* [Link children](#link-children)
|
||||
* [Templating symlinked dotfiles](#templating-symlinked-dotfiles)
|
||||
|
||||
---
|
||||
|
||||
# Link children
|
||||
|
||||
This feature can be very useful for dotfiles when you don't want the entire
|
||||
Reference in New Issue
Block a user