From e6f31a27b9231d92d61c736c0abd4ef70c8a95bb Mon Sep 17 00:00:00 2001 From: deadc0de6 Date: Mon, 14 Sep 2020 21:25:37 +0200 Subject: [PATCH] doc refactor --- docs/config-details.md | 4 ++-- docs/templating.md | 4 ++-- mkdocs.yml | 1 + 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/config-details.md b/docs/config-details.md index 1e4b86c..4c5bed4 100644 --- a/docs/config-details.md +++ b/docs/config-details.md @@ -172,8 +172,8 @@ dotfiles: For examples of transformation uses, see -* [Store compressed directories](howto/store-compressed-directories.md) -* [Sensitive dotfiles](howto/sensitive-dotfiles.md) +* [Handle compressed directories](howto/store-compressed-directories.md) +* [Handle secrets](howto/sensitive-dotfiles.md) **Note**: any transformation with a key starting with an underscore (`_`) won't be shown in output. This can be useful when working with sensitive data containing passwords for example. diff --git a/docs/templating.md b/docs/templating.md index 2ed14be..b5c7da2 100644 --- a/docs/templating.md +++ b/docs/templating.md @@ -25,9 +25,9 @@ Following variables are available in templates: * `{{@@ profile @@}}` contains the profile provided to dotdrop. * `{{@@ env['MY_VAR'] @@}}` contains environment variables (see [Environment variables](#environment-variables)). * `{{@@ header() @@}}` contains dotdrop header (see [Dotdrop header](#dotdrop-header)). -* `{{@@ _dotdrop_dotpath @@}}` contains the [dotpath](config.md) absolute path. +* `{{@@ _dotdrop_dotpath @@}}` contains the [dotpath](config-format.md) absolute path. * `{{@@ _dotdrop_cfgpath @@}}` contains the absolute path to the [config file](config.md). -* `{{@@ _dotdrop_workdir @@}}` contains the [workdir](config.md) absolute path. +* `{{@@ _dotdrop_workdir @@}}` contains the [workdir](config-format.md) absolute path. * dotfile specific variables (see [Dotfile variables](#dotfile-variables)) * config variables (see [Variables](config.md#variables)). * config interpreted variables (see [Interpreted variables](config-details.md#entry-dynvariables)). diff --git a/mkdocs.yml b/mkdocs.yml index f4b4a1a..8ebbb84 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,6 +9,7 @@ theme: collapse_navigation: false use_directory_urls: true nav: + - Dotdrop: 'README.md' - Installation: 'installation.md' - 'Repository setup': 'repository-setup.md' - Usage: 'usage.md'