docs: Split docs into sections for age, secret and state

twpayne · Oct 17, 2024 · e0c314f · e0c314f
1 parent 23777d0
commit e0c314f
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 24 deletions.
diff --git a/assets/chezmoi.io/docs/reference/commands/age.md b/assets/chezmoi.io/docs/reference/commands/age.md
@@ -2,18 +2,26 @@
 
 Interact with age's passphrase-based encryption.
 
-# `age encrypt` [*file*...]
+## Subcommands
 
-## `-p`, `--passphrase`
+### `age encrypt` [*file*...]
 
-Encrypt with a passphrase.
+Encrypt file or standard input.
 
-# `age decrypt` [*file*...]
+#### `-p`, `--passphrase`
 
-## `-p`, `--passphrase`
+Decrypt with a passphrase.
+
+### `age decrypt` [*file*...]
+
+Decrypt file or standard input.
+
+#### `-p`, `--passphrase`
 
 Decrypt with a passphrase.
 
+## Example
+
 !!! example
 
     ```console

diff --git a/assets/chezmoi.io/docs/reference/commands/secret.md b/assets/chezmoi.io/docs/reference/commands/secret.md
@@ -9,40 +9,44 @@ manager. Normally you would use chezmoi's existing template functions to retriev
     If you need to pass flags to the secret manager's CLI you must separate
     them with `--` to prevent chezmoi from interpreting them.
 
-# `secret keyring delete`
+## Subcommands
 
-## `--service` *string*
+### `secret keyring delete`
+
+#### `--service` *string*
 
 Name of the service.
 
-## `--user` *string*
+#### `--user` *string*
 
 Name of the user.
 
-# `secret keyring get`
+### `secret keyring get`
 
-## `--service` *string*
+#### `--service` *string*
 
 Name of the service.
 
-## `--user` *string*
+#### `--user` *string*
 
 Name of the user.
 
-# `secret keyring set`
+### `secret keyring set`
 
-## `--service` *string*
+#### `--service` *string*
 
 Name of the service.
 
-## `--user` *string*
+#### `--user` *string*
 
 Name of the user.
 
-## `--value` *string*
+#### `--value` *string*
 
 New value.
 
+## Example
+
 !!! example
 
     ```console
@@ -51,6 +55,8 @@ New value.
     $ chezmoi secret keyring delete --service=service --user=user
     ```
 
+## Warning
+
 !!! warning
 
     On FreeBSD, the `secret keyring` command is only available if chezmoi was

diff --git a/assets/chezmoi.io/docs/reference/commands/state.md b/assets/chezmoi.io/docs/reference/commands/state.md
@@ -10,40 +10,42 @@ Manipulate the persistent state.
     $ chezmoi state help
     ```
 
-# Available subcommands
+## Subcommands
 
-## `data`
+### `data`
 
 Print the raw data in the persistent state.
 
-## `delete`
+### `delete`
 
 Delete a value from the persistent state.
 
-## `delete-bucket`
+### `delete-bucket`
 
 Delete a bucket from the persistent state.
 
-## `dump`
+### `dump`
 
 Generate a dump of the persistent state.
 
-## `get`
+### `get`
 
 Get a value from the persistent state.
 
-## `get-bucket`
+### `get-bucket`
 
 Get a bucket from the persistent state.
 
-## `reset`
+### `reset`
 
 Reset the persistent state.
 
-## `set`
+### `set`
 
 Set a value from the persistent state
 
+## Example
+
 !!! example
 
     ```console