Skip to content

Commit

Permalink
Add templating doc skeleton
Browse files Browse the repository at this point in the history
  • Loading branch information
twpayne committed Oct 4, 2020
1 parent cfa3fd2 commit 404854d
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 9 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@ Manage your dotfiles across multiple machines, securely.

[Install chezmoi](docs/INSTALL.md) then read the [quick start
guide](docs/QUICKSTART.md). The [how-to guide](docs/HOWTO.md) covers most common
tasks, and there's the [frequently asked questions](docs/FAQ.md) for specific
questions. You can browse other people's dotfiles that use chezmoi [on
tasks, and there's both documentation on [templating](docs/TEMPLATING.md) and
[frequently asked questions](docs/FAQ.md) for specific questions. You can browse
other people's dotfiles that use chezmoi [on
GitHub](https://github.com/topics/chezmoi?o=desc&s=updated) and [on
GitLab](https://gitlab.com/search?search=chezmoi). For a full description of
chezmoi, consult the [reference](docs/REFERENCE.md).
Expand Down Expand Up @@ -190,6 +191,7 @@ Read what [people have said about chezmoi](docs/MEDIA.md).
one or two commands.
* [Quick start guide](docs/QUICKSTART.md) for your first steps.
* [How-to guide](docs/HOWTO.md) for achieving specific tasks.
* [Templating guide](docs/TEMPLATING.md) for working with templates.
* [FAQ](docs/FAQ.md) for questions that aren't answered elsewhere.
* [Changes](docs/CHANGES.md) for non-backwards compatible changes.
* [Reference](docs/REFERENCE.md) for a complete description of chezmoi.
Expand Down
6 changes: 5 additions & 1 deletion chezmoi.io/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ content-docs: \
content/docs/install.md \
content/docs/media.md \
content/docs/quick-start.md \
content/docs/reference.md
content/docs/reference.md \
content/docs/templating.md

content/docs/changes.md: ../docs/CHANGES.md ../internal/generate-chezmoi.io-content-docs/main.go Makefile
go run ../internal/generate-chezmoi.io-content-docs -shorttitle="Changes" -longtitle="Changes" < $< > $@ || ( rm -f $@ ; false )
Expand All @@ -36,3 +37,6 @@ content/docs/quick-start.md: ../docs/QUICKSTART.md ../internal/generate-chezmoi.

content/docs/reference.md: ../docs/REFERENCE.md ../internal/generate-chezmoi.io-content-docs/main.go Makefile
go run ../internal/generate-chezmoi.io-content-docs -shorttitle="Reference" -longtitle="Reference Manual" < $< > $@ || ( rm -f $@ ; false )

content/docs/templating.md: ../docs/TEMPLATING.md ../internal/generate-chezmoi.io-content-docs/main.go Makefile
go run ../internal/generate-chezmoi.io-content-docs -shorttitle="Templating" -longtitle="Templating Guide" < $< > $@ || ( rm -f $@ ; false )
12 changes: 7 additions & 5 deletions chezmoi.io/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ Manage your dotfiles across multiple machines, securely.

## How do I start with chezmoi now?

[Install chezmoi](/docs/install/) then read the [quick start
guide](/docs/quick-start/). The [how-to guide](/docs/how-to/) covers most common
tasks, and there's the [frequently asked questions](/docs/faq/) for specific
questions. You can browse other people's dotfiles that use chezmoi [on
[Install chezmoi](docs/INSTALL.md) then read the [quick start
guide](docs/QUICKSTART.md). The [how-to guide](docs/HOWTO.md) covers most common
tasks, and there's both documentation on [templating](docs/TEMPLATING.md) and
[frequently asked questions](docs/FAQ.md) for specific questions. You can browse
other people's dotfiles that use chezmoi [on
GitHub](https://github.com/topics/chezmoi?o=desc&s=updated) and [on
GitLab](https://gitlab.com/search?search=chezmoi). For a full description of
chezmoi, consult the [reference](/docs/reference/).
Expand Down Expand Up @@ -61,7 +62,7 @@ the configuration file in the format of your choice. chezmoi can retrieve
secrets from [1Password](https://1password.com/),
[Bitwarden](https://bitwarden.com/), [gopass](https://www.gopass.pw/),
[KeePassXC](https://keepassxc.org/), [LastPass](https://lastpass.com/),
[pass](https://www.passwordstore.org/), [Vault](https://www.vaultproject.io/),,
[pass](https://www.passwordstore.org/), [Vault](https://www.vaultproject.io/),
or any command-line utility of your choice. You can encrypt individual files
with [GnuPG](https://www.gnupg.org). You can checkout your dotfiles repo on as
many machines as you want without revealing any secrets to anyone.
Expand Down Expand Up @@ -174,6 +175,7 @@ Read what [people have said about chezmoi](docs/MEDIA.md).
one or two commands.
* [Quick start guide](/docs/quick-start/) for your first steps.
* [How-to guide](/docs/how-to/) for achieving specific tasks.
* [Templating guide](/docs/templating/) for working with templates.
* [FAQ](/docs/faq/) for questions that aren't answered elsewhere.
* [Changes](/docs/changes/) for non-backwards compatible changes.
* [Reference](/docs/reference/) for a complete description of chezmoi.
Expand Down
1 change: 1 addition & 0 deletions chezmoi.io/content/docs/menu/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ headless = true
- [Install]({{< relref "/docs/install.md" >}})
- [Quick Start]({{< relref "/docs/quick-start.md" >}})
- [How-To]({{< relref "/docs/how-to.md" >}})
- [Templating]({{< relref "/docs/templating.md" >}})
- [FAQ]({{< relref "/docs/faq.md" >}})
- [Changes]({{< relref "/docs/changes.md" >}})
- [Reference]({{< relref "/docs/reference.md" >}})
Expand Down
10 changes: 10 additions & 0 deletions cmd/docs.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions docs/TEMPLATING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# chezmoi Templating Guide

<!--- toc --->
* [Placeholder](#placeholder)

## Placeholder

This document is a placeholder for improved template documentation.
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//go:generate go run ./internal/generate-assets -o cmd/docs.gen.go -tags=!noembeddocs docs/CHANGES.md docs/CONTRIBUTING.md docs/FAQ.md docs/HOWTO.md docs/INSTALL.md docs/MEDIA.md docs/QUICKSTART.md docs/REFERENCE.md
//go:generate go run ./internal/generate-assets -o cmd/docs.gen.go -tags=!noembeddocs docs/CHANGES.md docs/CONTRIBUTING.md docs/FAQ.md docs/HOWTO.md docs/INSTALL.md docs/MEDIA.md docs/QUICKSTART.md docs/REFERENCE.md docs/TEMPLATING.md
//go:generate go run ./internal/generate-assets -o cmd/templates.gen.go assets/templates/COMMIT_MESSAGE.tmpl
//go:generate go run ./internal/generate-helps -o cmd/helps.gen.go -i docs/REFERENCE.md
//go:generate go run . completion bash -o completions/chezmoi-completion.bash
Expand Down

0 comments on commit 404854d

Please sign in to comment.