Skip to content

Commit 0a1e32c

Browse files
authored
docs: add include files documentation (#13)
1 parent 1883358 commit 0a1e32c

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

src/lib/docs/cli/build.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,16 @@ Include only the categories with these names. Corresponding config key: `include
5858
jsrepo build --include-categories utils scripts
5959
```
6060

61+
### `--include-files`
62+
63+
Additional files to include in the manifest. Corresponding config key: `includeFiles`
64+
65+
#### Usage
66+
67+
```sh
68+
jsrepo build --include-files ./src/**/*.txt
69+
```
70+
6171
### `--exclude-blocks`
6272

6373
Do not include the blocks with these names. Corresponding config key: `excludeBlocks`

src/lib/docs/registry/jsrepo-build-config-json.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,17 @@ The path of the file in your registry.
145145
}
146146
```
147147

148+
### `includeFiles`
149+
150+
Additional files to include in the manifest. This can be used to include arbitrary extra static files which don't have language support.
151+
This config option supports ignore style glob patterns.
152+
153+
```jsonc showLineNumbers
154+
{
155+
"includeFiles": ["./src/blocks/header/hero.png", "./src/**/*.txt"]
156+
}
157+
```
158+
148159
### `listBlocks`
149160

150161
`listBlocks` is a list of block names that should be listed when the user runs the `add` command.

0 commit comments

Comments
 (0)