From 9cd54ace8c9af76f0320293be85cafcda4e3eab1 Mon Sep 17 00:00:00 2001 From: deadc0de6 Date: Fri, 27 May 2022 15:19:52 +0200 Subject: [PATCH] update doc --- README.md | 12 ++++++------ docs/config-config.md | 2 +- docs/config-dotfiles.md | 2 +- docs/config-file.md | 2 +- docs/installation.md | 12 ++++++------ mkdocs.yml | 16 ++++++++-------- 6 files changed, 23 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 6fbf621..be71a3a 100644 --- a/README.md +++ b/README.md @@ -91,12 +91,12 @@ See the [installation instructions](https://dotdrop.readthedocs.io/en/latest/ins Dotdrop is available on: -* PyPI: https://pypi.org/project/dotdrop/ -* Homebrew: https://formulae.brew.sh/formula/dotdrop -* AUR (stable): https://aur.archlinux.org/packages/dotdrop/ -* AUR (git version): https://aur.archlinux.org/packages/dotdrop-git/ -* Snapcraft: https://snapcraft.io/dotdrop -* pacstall: https://github.com/pacstall/pacstall-programs/blob/master/packages/dotdrop/dotdrop.pacscript +* [PyPI](https://pypi.org/project/dotdrop/) +* [Homebrew](https://formulae.brew.sh/formula/dotdrop) +* [AUR (stable)](https://aur.archlinux.org/packages/dotdrop/) +* [AUR (git version)](https://aur.archlinux.org/packages/dotdrop-git/) +* [Snapcraft](https://snapcraft.io/dotdrop) +* [Pacstall](https://github.com/pacstall/pacstall-programs/blob/master/packages/dotdrop/dotdrop.pacscript) # Getting started diff --git a/docs/config-config.md b/docs/config-config.md index 4f0b865..fca9f9a 100644 --- a/docs/config-config.md +++ b/docs/config-config.md @@ -1,4 +1,4 @@ -# Config entry +# Config block The **config** entry (mandatory) contains global settings. diff --git a/docs/config-dotfiles.md b/docs/config-dotfiles.md index 8bf1355..c9c5c49 100644 --- a/docs/config-dotfiles.md +++ b/docs/config-dotfiles.md @@ -1,4 +1,4 @@ -# Dotfiles entry +# Dotfiles block The **dotfiles** entry (mandatory) contains a YAML object with sub-objects for the dotfiles managed by dotdrop. The entries in the sub-objects are as follows: diff --git a/docs/config-file.md b/docs/config-file.md index 8c5ac27..7a472d5 100644 --- a/docs/config-file.md +++ b/docs/config-file.md @@ -295,7 +295,7 @@ dotfiles: Dotdrop should be able to handle `toml` config file however this feature hasn't been extensively tested. A base [config.toml](/config.toml) is available to get started. -The script ([yaml-to-toml.py](/scripts/yaml-to-toml.py)) allows to convert a `yaml` dotdrop +The script [yaml-to-toml.py](/scripts/yaml-to-toml.py) allows to convert a `yaml` dotdrop config file to `toml`. For more see issue [#343](https://github.com/deadc0de6/dotdrop/issues/343). \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md index 342af13..ba5a8e4 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,11 +1,11 @@ # Installation -* PyPI: https://pypi.org/project/dotdrop/ -* Homebrew: https://formulae.brew.sh/formula/dotdrop -* AUR (stable): https://aur.archlinux.org/packages/dotdrop/ -* AUR (git version): https://aur.archlinux.org/packages/dotdrop-git/ -* Snapcraft: https://snapcraft.io/dotdrop -* pacstall: https://github.com/pacstall/pacstall-programs/blob/master/packages/dotdrop/dotdrop.pacscript +* [PyPI](https://pypi.org/project/dotdrop/) +* [Homebrew](https://formulae.brew.sh/formula/dotdrop) +* [AUR (stable)](https://aur.archlinux.org/packages/dotdrop/) +* [AUR (git version)](https://aur.archlinux.org/packages/dotdrop-git/) +* [Snapcraft](https://snapcraft.io/dotdrop) +* [Pacstall](https://github.com/pacstall/pacstall-programs/blob/master/packages/dotdrop/dotdrop.pacscript) ## As a submodule diff --git a/mkdocs.yml b/mkdocs.yml index 8a670cc..b1f2ec5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,14 +15,14 @@ nav: - 'Usage': 'usage.md' - 'Config': - 'Config file': 'config-file.md' - - 'Config': 'config-config.md' - - 'Dotfiles': 'config-dotfiles.md' - - 'Profiles': 'config-profiles.md' - - 'Actions': 'config-actions.md' - - 'Transformations': 'config-transformations.md' - - 'Variables': 'config-variables.md' - - 'Dynvariables': 'config-dynvars.md' - - 'Uservariables': 'config-uservars.md' + - 'Config block': 'config-config.md' + - 'Dotfiles block': 'config-dotfiles.md' + - 'Profiles block': 'config-profiles.md' + - 'Actions block': 'config-actions.md' + - 'Transformations block': 'config-transformations.md' + - 'Variables block': 'config-variables.md' + - 'Dynvariables block': 'config-dynvars.md' + - 'Uservariables block': 'config-uservars.md' - 'Templating': - 'Templating': 'templating.md' - 'More':