mirror of
https://github.com/deadc0de6/dotdrop.git
synced 2026-02-11 14:19:00 +00:00
update doc
This commit is contained in:
12
README.md
12
README.md
@@ -91,12 +91,12 @@ See the [installation instructions](https://dotdrop.readthedocs.io/en/latest/ins
|
|||||||
|
|
||||||
Dotdrop is available on:
|
Dotdrop is available on:
|
||||||
|
|
||||||
* PyPI: https://pypi.org/project/dotdrop/
|
* [PyPI](https://pypi.org/project/dotdrop/)
|
||||||
* Homebrew: https://formulae.brew.sh/formula/dotdrop
|
* [Homebrew](https://formulae.brew.sh/formula/dotdrop)
|
||||||
* AUR (stable): https://aur.archlinux.org/packages/dotdrop/
|
* [AUR (stable)](https://aur.archlinux.org/packages/dotdrop/)
|
||||||
* AUR (git version): https://aur.archlinux.org/packages/dotdrop-git/
|
* [AUR (git version)](https://aur.archlinux.org/packages/dotdrop-git/)
|
||||||
* Snapcraft: https://snapcraft.io/dotdrop
|
* [Snapcraft](https://snapcraft.io/dotdrop)
|
||||||
* pacstall: https://github.com/pacstall/pacstall-programs/blob/master/packages/dotdrop/dotdrop.pacscript
|
* [Pacstall](https://github.com/pacstall/pacstall-programs/blob/master/packages/dotdrop/dotdrop.pacscript)
|
||||||
|
|
||||||
# Getting started
|
# Getting started
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# Config entry
|
# Config block
|
||||||
|
|
||||||
The **config** entry (mandatory) contains global settings.
|
The **config** entry (mandatory) contains global settings.
|
||||||
|
|
||||||
|
|||||||
@@ -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:
|
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:
|
||||||
|
|
||||||
|
|||||||
@@ -295,7 +295,7 @@ dotfiles:
|
|||||||
Dotdrop should be able to handle `toml` config file however this
|
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.
|
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`.
|
config file to `toml`.
|
||||||
|
|
||||||
For more see issue [#343](https://github.com/deadc0de6/dotdrop/issues/343).
|
For more see issue [#343](https://github.com/deadc0de6/dotdrop/issues/343).
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
# Installation
|
# Installation
|
||||||
|
|
||||||
* PyPI: https://pypi.org/project/dotdrop/
|
* [PyPI](https://pypi.org/project/dotdrop/)
|
||||||
* Homebrew: https://formulae.brew.sh/formula/dotdrop
|
* [Homebrew](https://formulae.brew.sh/formula/dotdrop)
|
||||||
* AUR (stable): https://aur.archlinux.org/packages/dotdrop/
|
* [AUR (stable)](https://aur.archlinux.org/packages/dotdrop/)
|
||||||
* AUR (git version): https://aur.archlinux.org/packages/dotdrop-git/
|
* [AUR (git version)](https://aur.archlinux.org/packages/dotdrop-git/)
|
||||||
* Snapcraft: https://snapcraft.io/dotdrop
|
* [Snapcraft](https://snapcraft.io/dotdrop)
|
||||||
* pacstall: https://github.com/pacstall/pacstall-programs/blob/master/packages/dotdrop/dotdrop.pacscript
|
* [Pacstall](https://github.com/pacstall/pacstall-programs/blob/master/packages/dotdrop/dotdrop.pacscript)
|
||||||
|
|
||||||
## As a submodule
|
## As a submodule
|
||||||
|
|
||||||
|
|||||||
16
mkdocs.yml
16
mkdocs.yml
@@ -15,14 +15,14 @@ nav:
|
|||||||
- 'Usage': 'usage.md'
|
- 'Usage': 'usage.md'
|
||||||
- 'Config':
|
- 'Config':
|
||||||
- 'Config file': 'config-file.md'
|
- 'Config file': 'config-file.md'
|
||||||
- 'Config': 'config-config.md'
|
- 'Config block': 'config-config.md'
|
||||||
- 'Dotfiles': 'config-dotfiles.md'
|
- 'Dotfiles block': 'config-dotfiles.md'
|
||||||
- 'Profiles': 'config-profiles.md'
|
- 'Profiles block': 'config-profiles.md'
|
||||||
- 'Actions': 'config-actions.md'
|
- 'Actions block': 'config-actions.md'
|
||||||
- 'Transformations': 'config-transformations.md'
|
- 'Transformations block': 'config-transformations.md'
|
||||||
- 'Variables': 'config-variables.md'
|
- 'Variables block': 'config-variables.md'
|
||||||
- 'Dynvariables': 'config-dynvars.md'
|
- 'Dynvariables block': 'config-dynvars.md'
|
||||||
- 'Uservariables': 'config-uservars.md'
|
- 'Uservariables block': 'config-uservars.md'
|
||||||
- 'Templating':
|
- 'Templating':
|
||||||
- 'Templating': 'templating.md'
|
- 'Templating': 'templating.md'
|
||||||
- 'More':
|
- 'More':
|
||||||
|
|||||||
Reference in New Issue
Block a user