Skip to content

Commit 1cf9a7a

Browse files
author
John Doe
committed
refactor: wip
1 parent c7882cb commit 1cf9a7a

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

tools/zod2md-nx-plugin/README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ or with options:
2929
{
3030
"plugin": "./tools/zod2md-nx-plugin/src/lib/plugin.js",
3131
"options": {
32-
"targetName": "docs",
32+
"targetName": "zod-docs",
3333
},
3434
},
3535
],
@@ -58,6 +58,26 @@ The generated target:
5858
2. Formats the generated markdown with Prettier
5959
3. Caches the result for better performance
6060

61+
### Options
62+
63+
You can override the config and output paths when running the target:
64+
65+
```bash
66+
# Use custom output file
67+
nx generate-docs my-project --output=docs/custom-api.md
68+
69+
# Use custom config file
70+
nx generate-docs my-project --config=custom-zod2md.config.ts
71+
72+
# Use both
73+
nx generate-docs my-project --config=custom.config.ts --output=docs/api.md
74+
```
75+
76+
Default values:
77+
78+
- `config`: `{projectRoot}/zod2md.config.ts`
79+
- `output`: `{projectRoot}/docs/{projectName}-reference.md`
80+
6181
## Options
6282

6383
| Name | type | description |

0 commit comments

Comments
 (0)