Skip to content

Commit b0da47a

Browse files
committed
Improve docs
1 parent 44b6d72 commit b0da47a

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,21 @@ It is possible to keep a package in mrs-developer.json, but don't process it, by
7272
}
7373
```
7474

75+
You can override the default `output` provided via command line per repository in `mrs.developer.json`.
76+
77+
```json
78+
{
79+
"volto-light-theme": {
80+
"output": "addons",
81+
"package": "@kitconcept/volto-light-theme",
82+
"url": "git@github.com:kitconcept/volto-light-theme.git",
83+
"https": "https://github.com/kitconcept/volto-light-theme.git"
84+
}
85+
}
86+
```
87+
88+
This repository will be checked out in the `addons` directory, instead of the one provided via command line. It won't prepend the `src` prefix to it, if you still want it, you should provide it in the `output` key. This might be useful in combination with monorepos where you want to checkout packages into workspaces folders.
89+
7590
## Usage
7691

7792
```
@@ -154,7 +169,7 @@ Properties:
154169
- `branch`: Optional. Branch name, defaults to the remote's default branch. Ignored if `tag` is defined.
155170
- `tag`: Optional. Tag name.
156171
- `develop`: Optional. Boolean, can be toggled on/off to activate/deactivate a package. If activated, then deactivated afterwards, the package gets removed from `jsconfig` maintaining the synchronization with `mrs.developer.json`. Default is `true`.
157-
- `output`: Optional. Output directory override per repository. It also removes the `src/` prefix. If you still want it, you have to pass it along with the new output.
172+
- `output`: Optional. Output directory override per repository.
158173

159174
## Usage with (non-TypeScript) React
160175

0 commit comments

Comments
 (0)