Skip to content

Commit 87635c2

Browse files
committed
refactor: fix docs
1 parent a11c62c commit 87635c2

File tree

1 file changed

+0
-42
lines changed

1 file changed

+0
-42
lines changed

tools/zod2md-jsdocs/docs/zod2md-jsdocs-nx-plugin.md

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,6 @@ Why should you use this plugin?
1919
}
2020
```
2121

22-
or with options:
23-
24-
```jsonc
25-
// nx.json
26-
{
27-
//...
28-
"plugins": [
29-
{
30-
"plugin": "./tools/zod2md-jsdocs-nx-plugin/src/lib/plugin.js",
31-
"options": {
32-
"targetName": "zod-docs",
33-
},
34-
},
35-
],
36-
}
37-
```
38-
3922
Now every project with a `zod2md.config.ts` file will have a `generate-docs` target automatically created.
4023

4124
- `nx run <project-name>:generate-docs`
@@ -78,31 +61,6 @@ Default values:
7861
- `config`: `{projectRoot}/zod2md.config.ts`
7962
- `output`: `{projectRoot}/docs/{projectName}-reference.md`
8063

81-
## Options
82-
83-
| Name | type | description |
84-
| --------------------------- | ---------------------------------- | ------------------------------------------------------------------- |
85-
| **docsTargetName** | `string` (DEFAULT 'generate-docs') | The name of the docs generation target. |
86-
| **jsDocsTypesAugmentation** | `boolean` (DEFAULT `true`) | Whether to enable TypeScript transformer integration with ts-patch. |
87-
88-
All options are optional and provided in the `nx.json` file.
89-
90-
```jsonc
91-
// nx.json
92-
{
93-
//...
94-
"plugins": [
95-
{
96-
"plugin": "./tools/zod2md-jsdocs-nx-plugin/src/lib/plugin.js",
97-
"options": {
98-
"docsTargetName": "docs",
99-
"jsDocsTypesAugmentation": true,
100-
},
101-
},
102-
],
103-
}
104-
```
105-
10664
## Configuration
10765

10866
Create a `zod2md.config.ts` file in your project:

0 commit comments

Comments
 (0)