Skip to content

Commit 9524a30

Browse files
committed
docs: update README
1 parent 34e91c9 commit 9524a30

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,12 @@ All fields in `defaults` apply to all sources unless overridden per-source.
9494
| `mode` | Cache mode. Default: `"materialize"`. |
9595
| `include` | Glob patterns to copy. Default: `["**/*.{md,mdx,markdown,mkd,txt,rst,adoc,asciidoc}"]`. |
9696
| `targetMode` | How to link or copy from the cache to the destination. Default: `"symlink"` on Unix, `"copy"` on Windows. |
97-
| `depth` | Git clone depth. Default: `1`. |
9897
| `required` | Whether missing sources should fail. Default: `true`. |
9998
| `maxBytes` | Maximum total bytes to materialize. Default: `200000000` (200 MB). |
10099
| `maxFiles` | Maximum total files to materialize. |
101100
| `allowHosts` | Allowed Git hosts. Default: `["github.com", "gitlab.com"]`. |
102101
| `toc` | Generate per-source `TOC.md`. Default: `true`. Supports `true`, `false`, or a format (`"tree"`, `"compressed"`). |
102+
| `unwrapSingleRootDir` | If the materialized output is nested under a single directory, unwrap it (recursively). Default: `false`. |
103103

104104
### Source options
105105

@@ -123,6 +123,7 @@ All fields in `defaults` apply to all sources unless overridden per-source.
123123
| `maxBytes` | Maximum total bytes to materialize. |
124124
| `maxFiles` | Maximum total files to materialize. |
125125
| `toc` | Generate per-source `TOC.md`. Supports `true`, `false`, or a format (`"tree"`, `"compressed"`). |
126+
| `unwrapSingleRootDir` | If the materialized output is nested under a single directory, unwrap it (recursively). |
126127

127128
> **Note**: Sources are always downloaded to `.docs/<id>/`. If you provide a `targetDir`, `docs-cache` will create a symlink or copy pointing from the cache to that target directory. The target should be outside `.docs`. Git operation timeout is configured via the `--timeout-ms` CLI flag, not as a per-source configuration option.
128129

0 commit comments

Comments
 (0)