Skip to content

Commit

Permalink
Update tables of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
@twpayne
twpayne committed Jun 20, 2019
1 parent 5bdbde1 commit 8e92a90
Show file tree
Hide file tree
Showing 7 changed files with 68 additions and 68 deletions.
10 changes: 5 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Status](https://travis-ci.org/twpayne/chezmoi.svg?branch=master)](https://travis

Manage your dotfiles across multiple machines, securely.

* [Documentation](#documentation)
* [What does chezmoi do and why should I use it?](#what-does-chezmoi-do-and-why-should-i-use-it)
* [What are chezmoi's key features?](#what-are-chezmois-key-features)
* [I already have a system to manage my dotfiles, why should I use chezmoi?](#i-already-have-a-system-to-manage-my-dotfiles-why-should-i-use-chezmoi)
* [License](#license)
* [Documentation](#Documentation)
* [What does chezmoi do and why should I use it?](#What-does-chezmoi-do-and-why-should-I-use-it)
* [What are chezmoi's key features?](#What-are-chezmois-key-features)
* [I already have a system to manage my dotfiles, why should I use chezmoi?](#I-already-have-a-system-to-manage-my-dotfiles-why-should-I-use-chezmoi)
* [License](#License)

## Documentation

Expand Down
4 changes: 2 additions & 2 deletions docs/CHANGES.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# chezmoi Changes

* [Upcoming](#upcoming)
* [`gpgRecipient` config variable changing to `gpg.recipient`](#gpgrecipient-config-variable-changing-to-gpgrecipient)
* [Upcoming](#Upcoming)
* [`gpgRecipient` config variable changing to `gpg.recipient`](#gpgRecipient-config-variable-changing-to-gpgrecipient)

## Upcoming

Expand Down
10 changes: 5 additions & 5 deletions docs/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# chezmoi Contributing Guide

* [Getting started](#getting-started)
* [Developing locally](#developing-locally)
* [Contributing changes](#contributing-changes)
* [Managing releases](#managing-releases)
* [Packaging](#packaging)
* [Getting started](#Getting-started)
* [Developing locally](#Developing-locally)
* [Contributing changes](#Contributing-changes)
* [Managing releases](#Managing-releases)
* [Packaging](#Packaging)

## Getting started

Expand Down
26 changes: 13 additions & 13 deletions docs/FAQ.md
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# chezmoi Frequently Asked Questions

* [How can I quickly check for problems with chezmoi on my machine?](#how-can-i-quickly-check-for-problems-with-chezmoi-on-my-machine)
* [What are the consequences of "bare" modifications to the target files? If my `.zshrc` is managed by chezmoi and I edit `~/.zshrc` without using `chezmoi edit`, what happens?](#what-are-the-consequences-of-bare-modifications-to-the-target-files-if-my-zshrc-is-managed-by-chezmoi-and-i-edit-zshrc-without-using-chezmoi-edit-what-happens)
* [How can I tell what dotfiles in my home directory aren't managed by chezmoi? Is there an easy way to have chezmoi manage a subset of them?](#how-can-i-tell-what-dotfiles-in-my-home-directory-arent-managed-by-chezmoi-is-there-an-easy-way-to-have-chezmoi-manage-a-subset-of-them)
* [If there's a mechanism in place for the above, is there also a way to tell chezmoi to ignore specific files or groups of files (e.g. by directory name or by glob)?](#if-theres-a-mechanism-in-place-for-the-above-is-there-also-a-way-to-tell-chezmoi-to-ignore-specific-files-or-groups-of-files-eg-by-directory-name-or-by-glob)
* [If the target already exists, but is "behind" the source, can chezmoi be configured to preserve the target version before replacing it with one derived from the source?](#if-the-target-already-exists-but-is-behind-the-source-can-chezmoi-be-configured-to-preserve-the-target-version-before-replacing-it-with-one-derived-from-the-source)
* [I've made changes to both the destination state and the source state that I want to keep. How can I keep them both?](#ive-made-changes-to-both-the-destination-state-and-the-source-state-that-i-want-to-keep-how-can-i-keep-them-both)
* [How do I tell chezmoi to always delete a file?](#how-do-i-tell-chezmoi-to-always-delete-a-file)
* [gpg encryption fails. What could be wrong?](#gpg-encryption-fails-what-could-be-wrong)
* [What inspired chezmoi?](#what-inspired-chezmoi)
* [Can I use chezmoi outside my home directory?](#can-i-use-chezmoi-outside-my-home-directory)
* [Where does the name "chezmoi" come from?](#where-does-the-name-chezmoi-come-from)
* [What other questions have been asked about chezmoi?](#what-other-questions-have-been-asked-about-chezmoi)
* [Where do I ask a question that isn't answered here?](#where-do-i-ask-a-question-that-isnt-answered-here)
* [How can I quickly check for problems with chezmoi on my machine?](#How-can-I-quickly-check-for-problems-with-chezmoi-on-my-machine)
* [What are the consequences of "bare" modifications to the target files? If my `.zshrc` is managed by chezmoi and I edit `~/.zshrc` without using `chezmoi edit`, what happens?](#What-are-the-consequences-of-bare-modifications-to-the-target-files-If-my-zshrc-is-managed-by-chezmoi-and-I-edit-zshrc-without-using-chezmoi-edit-what-happens)
* [How can I tell what dotfiles in my home directory aren't managed by chezmoi? Is there an easy way to have chezmoi manage a subset of them?](#How-can-I-tell-what-dotfiles-in-my-home-directory-arent-managed-by-chezmoi-Is-there-an-easy-way-to-have-chezmoi-manage-a-subset-of-them)
* [If there's a mechanism in place for the above, is there also a way to tell chezmoi to ignore specific files or groups of files (e.g. by directory name or by glob)?](#If-theres-a-mechanism-in-place-for-the-above-is-there-also-a-way-to-tell-chezmoi-to-ignore-specific-files-or-groups-of-files-eg-by-directory-name-or-by-glob)
* [If the target already exists, but is "behind" the source, can chezmoi be configured to preserve the target version before replacing it with one derived from the source?](#If-the-target-already-exists-but-is-behind-the-source-can-chezmoi-be-configured-to-preserve-the-target-version-before-replacing-it-with-one-derived-from-the-source)
* [I've made changes to both the destination state and the source state that I want to keep. How can I keep them both?](#Ive-made-changes-to-both-the-destination-state-and-the-source-state-that-I-want-to-keep-How-can-I-keep-them-both)
* [How do I tell chezmoi to always delete a file?](#How-do-I-tell-chezmoi-to-always-delete-a-file)
* [gpg encryption fails. What could be wrong?](#gpg-encryption-fails-What-could-be-wrong)
* [What inspired chezmoi?](#What-inspired-chezmoi)
* [Can I use chezmoi outside my home directory?](#Can-I-use-chezmoi-outside-my-home-directory)
* [Where does the name "chezmoi" come from?](#Where-does-the-name-chezmoi-come-from)
* [What other questions have been asked about chezmoi?](#What-other-questions-have-been-asked-about-chezmoi)
* [Where do I ask a question that isn't answered here?](#Where-do-I-ask-a-question-that-isnt-answered-here)

## How can I quickly check for problems with chezmoi on my machine?

Expand Down
44 changes: 22 additions & 22 deletions docs/HOWTO.md
View file
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# chezmoi How-To Guide

* [Use a hosted repo to manage your dotfiles across multiple machines](#use-a-hosted-repo-to-manage-your-dotfiles-across-multiple-machines)
* [Use templates to manage files that vary from machine to machine](#use-templates-to-manage-files-that-vary-from-machine-to-machine)
* [Create a config file on a new machine automatically](#create-a-config-file-on-a-new-machine-automatically)
* [Keep data private](#keep-data-private)
* [Use Bitwarden to keep your secrets](#use-bitwarden-to-keep-your-secrets)
* [Use gpg to keep your secrets](#use-gpg-to-keep-your-secrets)
* [Use KeePassXC to keep your secrets](#use-keepassxc-to-keep-your-secrets)
* [Use a keyring to keep your secrets](#use-a-keyring-to-keep-your-secrets)
* [Use LastPass to keep your secrets](#use-lastpass-to-keep-your-secrets)
* [Use 1Password to keep your secrets](#use-1password-to-keep-your-secrets)
* [Use pass to keep your secrets](#use-pass-to-keep-your-secrets)
* [Use Vault to keep your secrets](#use-vault-to-keep-your-secrets)
* [Use a generic tool to keep your secrets](#use-a-generic-tool-to-keep-your-secrets)
* [Use templates variables to keep your secrets](#use-templates-variables-to-keep-your-secrets)
* [Use scripts to perform actions](#use-scripts-to-perform-actions)
* [Understand how scripts work](#understand-how-scripts-work)
* [Install packages with scripts](#install-packages-with-scripts)
* [Import archives](#import-archives)
* [Export archives](#export-archives)
* [Use a non-git version control system](#use-a-non-git-version-control-system)
* [Use a merge tool other than vimdiff](#use-a-merge-tool-other-than-vimdiff)
* [Migrate from a dotfile manager that uses symlinks](#migrate-from-a-dotfile-manager-that-uses-symlinks)
* [Use a hosted repo to manage your dotfiles across multiple machines](#Use-a-hosted-repo-to-manage-your-dotfiles-across-multiple-machines)
* [Use templates to manage files that vary from machine to machine](#Use-templates-to-manage-files-that-vary-from-machine-to-machine)
* [Create a config file on a new machine automatically](#Create-a-config-file-on-a-new-machine-automatically)
* [Keep data private](#Keep-data-private)
* [Use Bitwarden to keep your secrets](#Use-Bitwarden-to-keep-your-secrets)
* [Use gpg to keep your secrets](#Use-gpg-to-keep-your-secrets)
* [Use KeePassXC to keep your secrets](#Use-KeePassXC-to-keep-your-secrets)
* [Use a keyring to keep your secrets](#Use-a-keyring-to-keep-your-secrets)
* [Use LastPass to keep your secrets](#Use-LastPass-to-keep-your-secrets)
* [Use 1Password to keep your secrets](#Use-1Password-to-keep-your-secrets)
* [Use pass to keep your secrets](#Use-pass-to-keep-your-secrets)
* [Use Vault to keep your secrets](#Use-Vault-to-keep-your-secrets)
* [Use a generic tool to keep your secrets](#Use-a-generic-tool-to-keep-your-secrets)
* [Use templates variables to keep your secrets](#Use-templates-variables-to-keep-your-secrets)
* [Use scripts to perform actions](#Use-scripts-to-perform-actions)
* [Understand how scripts work](#Understand-how-scripts-work)
* [Install packages with scripts](#Install-packages-with-scripts)
* [Import archives](#Import-archives)
* [Export archives](#Export-archives)
* [Use a non-git version control system](#Use-a-non-git-version-control-system)
* [Use a merge tool other than vimdiff](#Use-a-merge-tool-other-than-vimdiff)
* [Migrate from a dotfile manager that uses symlinks](#Migrate-from-a-dotfile-manager-that-uses-symlinks)

## Use a hosted repo to manage your dotfiles across multiple machines

Expand Down
12 changes: 6 additions & 6 deletions docs/INSTALL.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# chezmoi Install Guide

* [One-line binary install](#one-line-binary-install)
* [One-line package install](#one-line-package-install)
* [Pre-built Linux packages](#pre-built-linux-packages)
* [Pre-built binaries](#pre-built-binaries)
* [From source](#from-source)
* [Upgrading](#upgrading)
* [One-line binary install](#One-line-binary-install)
* [One-line package install](#One-line-package-install)
* [Pre-built Linux packages](#Pre-built-Linux-packages)
* [Pre-built binaries](#Pre-built-binaries)
* [From source](#From-source)
* [Upgrading](#Upgrading)

## One-line binary install

Expand Down
30 changes: 15 additions & 15 deletions docs/REFERENCE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@

Manage your dotfiles securely across multiple machines.

* [Concepts](#concepts)
* [Global command line flags](#global-command-line-flags)
* [Concepts](#Concepts)
* [Global command line flags](#Global-command-line-flags)
* [`--color` *value*](#--color-value)
* [`-c`, `--config` *filename*](#-c---config-filename)
* [`-D`, `--destination` *directory*](#-d---destination-directory)
* [`-D`, `--destination` *directory*](#-D---destination-directory)
* [`-n`, `--dry-run`](#-n---dry-run)
* [`-h`, `--help`](#-h---help)
* [`-S`, `--source` *directory*](#-s---source-directory)
* [`-S`, `--source` *directory*](#-S---source-directory)
* [`-v`, `--verbose`](#-v---verbose)
* [`--version`](#--version)
* [Configuration file](#configuration-file)
* [Configuration variables](#configuration-variables)
* [Attributes](#attributes)
* [Special files and directories](#special-files-and-directories)
* [Configuration file](#Configuration-file)
* [Configuration variables](#Configuration-variables)
* [Attributes](#Attributes)
* [Special files and directories](#Special-files-and-directories)
* [`.chezmoi.<format>.tmpl`](#chezmoiformattmpl)
* [`.chezmoiignore`](#chezmoiignore)
* [`.chezmoitemplates`](#chezmoitemplates)
* [`.chezmoiversion`](#chezmoiversion)
* [Commands](#commands)
* [Commands](#Commands)
* [`add` *targets*](#add-targets)
* [`apply` [*targets*]](#apply-targets)
* [`archive`](#archive)
Expand All @@ -47,19 +47,19 @@ Manage your dotfiles securely across multiple machines.
* [`update`](#update)
* [`upgrade`](#upgrade)
* [`verify` [*targets*]](#verify-targets)
* [Editor configuration](#editor-configuration)
* [Umask configuration](#umask-configuration)
* [Template variables](#template-variables)
* [Template functions](#template-functions)
* [Editor configuration](#Editor-configuration)
* [Umask configuration](#Umask-configuration)
* [Template variables](#Template-variables)
* [Template functions](#Template-functions)
* [`bitwarden` [*args*]](#bitwarden-args)
* [`keepassxc` *entry*](#keepassxc-entry)
* [`keyring` *service* *user*](#keyring-service-user)
* [`lastpass` *id*](#lastpass-id)
* [`onepassword` *uuid*](#onepassword-uuid)
* [`pass` *pass-name*](#pass-pass-name)
* [`promptString` *prompt*](#promptstring-prompt)
* [`promptString` *prompt*](#promptString-prompt)
* [`secret` [*args*]](#secret-args)
* [`secretJSON` [*args*]](#secretjson-args)
* [`secretJSON` [*args*]](#secretJSON-args)
* [`vault` *key*](#vault-key)

## Concepts
Expand Down

0 comments on commit 8e92a90

Please sign in to comment.