Skip to content

Commit

Permalink
docs: Fill reference title page
Browse files Browse the repository at this point in the history
  • Loading branch information
KapJI authored and twpayne committed Oct 25, 2024
1 parent 2a41aeb commit b8610d4
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 1 deletion.
7 changes: 7 additions & 0 deletions assets/chezmoi.io/docs/reference/commands/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Commands

This section provides documentation for chezmoi commands and their arguments.

All commands accept [global flags](../command-line-flags/global.md),
though some flags may have no effect on certain commands.
Many commands also share [common flags](../command-line-flags/common.md).
18 changes: 17 additions & 1 deletion assets/chezmoi.io/docs/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# Reference

Manage your dotfiles across multiple machines, securely.
Welcome to the reference section of the chezmoi documentation.

This reference covers the following topics:

- [Key concepts](concepts.md)
- [Source state attributes](source-state-attributes.md)
- [Target types](target-types.md)
- [Application order of changes](application-order.md)
- [Configuration file](configuration-file/index.md)
- [Special files](special-files/index.md) and [special directories](special-directories/index.md)
- [Commands](commands/index.md)
- [Templates](templates/index.md)
- [Variables](templates/variables.md)
- [Directives](templates/directives.md)
- [Functions](templates/functions/index.md)
- [Plugins support](plugins.md)
- [Release history](release-history.md)
1 change: 1 addition & 0 deletions assets/chezmoi.io/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ nav:
- .chezmoiscripts: reference/special-directories/chezmoiscripts.md
- .chezmoitemplates: reference/special-directories/chezmoitemplates.md
- Commands:
- reference/commands/index.md
- add: reference/commands/add.md
- age: reference/commands/age.md
- apply: reference/commands/apply.md
Expand Down
3 changes: 3 additions & 0 deletions internal/cmd/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,9 @@ func init() {
}

for _, dirEntry := range dirEntries {
if dirEntry.Name() == "index.md" {
continue
}
command := strings.TrimSuffix(dirEntry.Name(), ".md")
data, err := commands.FS.ReadFile(dirEntry.Name())
if err != nil {
Expand Down

0 comments on commit b8610d4

Please sign in to comment.