mirror of
https://github.com/deadc0de6/dotdrop.git
synced 2026-02-11 18:54:00 +00:00
improve documentation
This commit is contained in:
@@ -115,15 +115,7 @@ On `update`, the following rule is applied:
|
|||||||
|
|
||||||
## Symlinking dotfiles
|
## Symlinking dotfiles
|
||||||
|
|
||||||
Dotdrop is able to install dotfiles in three different ways,
|
see the [symlink dotfiles documentation](howto/symlink-dotfiles.md).
|
||||||
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).
|
|
||||||
|
|
||||||
## Template config entries
|
## Template config entries
|
||||||
|
|
||||||
|
|||||||
@@ -36,6 +36,10 @@
|
|||||||
|
|
||||||
[Merge files on install](merge-files-when-installing.md)
|
[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
|
||||||
|
|
||||||
[Share content across dotfiles](sharing-content.md)
|
[Share content across dotfiles](sharing-content.md)
|
||||||
@@ -43,7 +47,3 @@
|
|||||||
## Symlink dotfiles
|
## Symlink dotfiles
|
||||||
|
|
||||||
[Symlink dotfiles](symlink-dotfiles.md)
|
[Symlink dotfiles](symlink-dotfiles.md)
|
||||||
|
|
||||||
## Prompt user for variables
|
|
||||||
|
|
||||||
[Prompt user for variables](prompt-user-for-variables.md)
|
|
||||||
|
|||||||
@@ -1,13 +1,12 @@
|
|||||||
# Symlink dotfiles
|
# Symlink dotfiles
|
||||||
|
|
||||||
Dotdrop offers two ways to symlink a dotfile through its
|
Dotdrop is able to install dotfiles in three different ways,
|
||||||
config entry `link`:
|
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`
|
* `link: nolink`: The dotfile (file or directory) is copied to its destination
|
||||||
* Setting `link: link_children` will, for every direct child of `src`, symlink `dst/<childrenX>` to `src/<childrenX>` (See [Link children](#link-children))
|
* `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
|
||||||
where `src` is the file stored in your *dotpath* and
|
* `link: link_children`: The files/directories found under the dotfile (directory) are symlinked to their destination. For every direct child of `src`, symlink `dst/<childrenX>` to `src/<childrenX>` (See [Link children](#link-children))
|
||||||
`dst` is the file located in your `$HOME`.
|
|
||||||
|
|
||||||
Note that if the dotfile uses template directives, it will be symlinked into
|
Note that if the dotfile uses template directives, it will be symlinked into
|
||||||
`~/.config/dotdrop` instead of directly into your *dotpath*
|
`~/.config/dotdrop` instead of directly into your *dotpath*
|
||||||
|
|||||||
17
mkdocs.yml
17
mkdocs.yml
@@ -25,8 +25,21 @@ nav:
|
|||||||
- 'Uservariables block': 'config-uservars.md'
|
- 'Uservariables block': 'config-uservars.md'
|
||||||
- 'Templating':
|
- 'Templating':
|
||||||
- 'Templating': 'templating.md'
|
- 'Templating': 'templating.md'
|
||||||
- 'More':
|
- 'HowTo':
|
||||||
- 'HowTo': 'howto/howto.md'
|
- '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:
|
markdown_extensions:
|
||||||
- meta
|
- meta
|
||||||
- tables
|
- tables
|
||||||
|
|||||||
Reference in New Issue
Block a user