diff --git a/docs/config-file.md b/docs/config-file.md index 0865d19..75ed7b4 100644 --- a/docs/config-file.md +++ b/docs/config-file.md @@ -115,15 +115,7 @@ On `update`, the following rule is applied: ## Symlinking dotfiles -Dotdrop is able to install dotfiles in three different ways, -which are controlled by the `link` config attribute of each dotfile: - -* `link: nolink`: The dotfile (file or directory) is copied to its destination -* `link: absolute`: The dotfile (file or directory) is linked to its destination using an absolute symlink -* `link: relative`: The dotfile (file or directory) is linked to its destination using a relative symlink -* `link: link_children`: The files/directories found under the dotfile (directory) are symlinked to their destination - -For more, see [this how-to](howto/symlink-dotfiles.md). +see the [symlink dotfiles documentation](howto/symlink-dotfiles.md). ## Template config entries diff --git a/docs/howto/howto.md b/docs/howto/howto.md index 0dae537..cd65757 100644 --- a/docs/howto/howto.md +++ b/docs/howto/howto.md @@ -36,6 +36,10 @@ [Merge files on install](merge-files-when-installing.md) +## Prompt user for variables + +[Prompt user for variables](prompt-user-for-variables.md) + ## Share content across dotfiles [Share content across dotfiles](sharing-content.md) @@ -43,7 +47,3 @@ ## Symlink dotfiles [Symlink dotfiles](symlink-dotfiles.md) - -## Prompt user for variables - -[Prompt user for variables](prompt-user-for-variables.md) diff --git a/docs/howto/symlink-dotfiles.md b/docs/howto/symlink-dotfiles.md index 9353728..362a5b3 100644 --- a/docs/howto/symlink-dotfiles.md +++ b/docs/howto/symlink-dotfiles.md @@ -1,13 +1,12 @@ # Symlink dotfiles -Dotdrop offers two ways to symlink a dotfile through its -config entry `link`: +Dotdrop is able to install dotfiles in three different ways, +which are controlled by the `link` config attribute of each dotfile: -* Setting `link: absolute` or `link: relative` for a dotfile will symlink `dst` to `src` -* Setting `link: link_children` will, for every direct child of `src`, symlink `dst/` to `src/` (See [Link children](#link-children)) - -where `src` is the file stored in your *dotpath* and -`dst` is the file located in your `$HOME`. +* `link: nolink`: The dotfile (file or directory) is copied to its destination +* `link: absolute`: The dotfile (file or directory) is linked to its destination using an absolute symlink +* `link: relative`: The dotfile (file or directory) is linked to its destination using a relative symlink +* `link: link_children`: The files/directories found under the dotfile (directory) are symlinked to their destination. For every direct child of `src`, symlink `dst/` to `src/` (See [Link children](#link-children)) Note that if the dotfile uses template directives, it will be symlinked into `~/.config/dotdrop` instead of directly into your *dotpath* diff --git a/mkdocs.yml b/mkdocs.yml index b1f2ec5..072b4bd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -25,8 +25,21 @@ nav: - 'Uservariables block': 'config-uservars.md' - 'Templating': - 'Templating': 'templating.md' - - 'More': - - 'HowTo': 'howto/howto.md' + - 'HowTo': + - 'Append text to a dotfile on install': 'howto/append.md' + - 'Create files on install': 'howto/create-special-files.md' + - 'Handle compressed directories': 'howto/store-compressed-directories.md' + - 'Handle secrets': 'howto/sensitive-dotfiles.md' + - 'Handle special chars': 'howto/special-chars.md' + - 'Improve Git integration': 'howto/improve-git-integration.md' + - 'Include files or templates in templates': 'howto/include-in-template.md' + - 'Manage system dotfiles': 'howto/system-config-files.md' + - 'Merge files on install': 'howto/merge-files-when-installing.md' + - 'Prompt user for variables': 'howto/prompt-user-for-variables.md' + - 'Share content across dotfiles': 'howto/sharing-content.md' + - 'Symlink dotfiles': 'howto/symlink-dotfiles.md' + + markdown_extensions: - meta - tables