mirrors/dotdrop
1
0
Fork 0
mirror of https://github.com/deadc0de6/dotdrop.git synced 2026-02-08 09:04:16 +00:00
Code Activity

migrate the doc to rtd

Browse Source
This commit is contained in:
deadc0de6
2020-09-14 21:39:00 +02:00
parent e6f31a27b9
commit 5d2a556bb8
2 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@@ -127,7 +127,7 @@ potential *included* entries
* profile's *include * profile's *include
Variables are then used to resolve different elements in the config file: Variables are then used to resolve different elements in the config file:
see [this](https://github.com/deadc0de6/dotdrop/wiki/config-variables#config-available-variables) see [this](docs/config.md#variables)
## rules ## rules
@@ -185,4 +185,4 @@ start of your new test (see the head of the file down to `# this is the test`).
# documentation # documentation
Most of dotdrop documentation is hosted in [its wiki](https://github.com/deadc0de6/dotdrop/wiki) Dotdrop documentation is available under [https://dotdrop.readthedocs.io/](https://dotdrop.readthedocs.io/).

26
README.md
View File

@@ -39,8 +39,8 @@ Features:
* Provide solutions for handling dotfiles containing sensitive information * Provide solutions for handling dotfiles containing sensitive information
Check also the [blog post](https://deadc0de.re/articles/dotfiles.html), Check also the [blog post](https://deadc0de.re/articles/dotfiles.html),
the [example](#getting-started), the [wiki](https://github.com/deadc0de6/dotdrop/wiki) or the [example](#getting-started), the [documentation](https://dotdrop.readthedocs.io/) or
how [people are using dotdrop](https://github.com/deadc0de6/dotdrop/wiki/meta-people-using-dotdrop) how [people are using dotdrop](https://dotdrop.readthedocs.io/en/latest/misc/people-using-dotdrop/)
for more. for more.
Quick start: Quick start:
@@ -83,7 +83,7 @@ you are cloning your dotfiles git tree from you'll have dotdrop shipped with it.
Below instructions show how to install dotdrop as a submodule. For alternative Below instructions show how to install dotdrop as a submodule. For alternative
installation instructions (with virtualenv, pypi, aur, snap, etc) see the installation instructions (with virtualenv, pypi, aur, snap, etc) see the
[wiki installation page](https://github.com/deadc0de6/dotdrop/wiki/installation). [installation documentation](https://dotdrop.readthedocs.io/en/latest/installation/).
Dotdrop is also available on Dotdrop is also available on
* pypi: https://pypi.org/project/dotdrop/ * pypi: https://pypi.org/project/dotdrop/
@@ -130,7 +130,7 @@ Completion scripts exist for `bash`, `zsh` and `fish`, see [the related doc](com
Create a new repository to store your dotfiles with dotdrop. *Init* or *clone* Create a new repository to store your dotfiles with dotdrop. *Init* or *clone*
that new repository and that new repository and
[install dotdrop](https://github.com/deadc0de6/dotdrop/wiki/installation#as-a-submodule). [install dotdrop](https://dotdrop.readthedocs.io/en/latest/installation/#as-a-submodule).
Then import any dotfiles (files or directories) you want to manage with dotdrop. Then import any dotfiles (files or directories) you want to manage with dotdrop.
You can either use the default profile (which resolves to the *hostname* of the host You can either use the default profile (which resolves to the *hostname* of the host
@@ -178,7 +178,7 @@ profiles:
- d_polybar - d_polybar
``` ```
For a description of the different fields and their use, For a description of the different fields and their use,
see the [config doc](https://github.com/deadc0de6/dotdrop/wiki/config). see the [config doc](https://dotdrop.readthedocs.io/en/latest/config-format/).
Commit and push your changes. Commit and push your changes.
@@ -207,7 +207,7 @@ profiles:
- d_polybar - d_polybar
``` ```
Then adapt any dotfile using the [templating](https://github.com/deadc0de6/dotdrop/wiki/templating) Then adapt any dotfile using the [templating](https://dotdrop.readthedocs.io/en/latest/templating/)
feature (if needed). For example you might want different fonts sizes on polybar for the different feature (if needed). For example you might want different fonts sizes on polybar for the different
hosts: hosts:
@@ -263,17 +263,17 @@ That's it, a single repository with all your dotfiles for your different hosts.
You can then You can then
* [create actions](https://github.com/deadc0de6/dotdrop/wiki/config-actions) * [create actions](https://dotdrop.readthedocs.io/en/latest/config-details/#entry-actions)
* [use transformations](https://github.com/deadc0de6/dotdrop/wiki/config-transformations) * [use transformations](https://dotdrop.readthedocs.io/en/latest/config-details/#entry-transformations)
* [use variables](https://github.com/deadc0de6/dotdrop/wiki/config-variables) * [use variables](https://dotdrop.readthedocs.io/en/latest/config/#variables)
* [symlink dotfiles](https://github.com/deadc0de6/dotdrop/wiki/symlinked-dotfiles) * [symlink dotfiles](https://dotdrop.readthedocs.io/en/latest/config/#symlink-dotfiles)
* [and more](https://github.com/deadc0de6/dotdrop/wiki) * [and more](https://dotdrop.readthedocs.io)
For more options see `dotdrop --help` and the [wiki](https://github.com/deadc0de6/dotdrop/wiki). For more options see `dotdrop --help` and the [documentation](https://dotdrop.readthedocs.io).
# Documentation # Documentation
Dotdrop's documentation is hosted on [its wiki](https://github.com/deadc0de6/dotdrop/wiki). Dotdrop's documentation is hosted on [readthedocs](https://dotdrop.readthedocs.io/en/latest/).
# Thank you # Thank you