Skip to content

Commit 0dba95a

Browse files
Mhmod-HsnMhmod-Hsn
authored
docs: fix table formatting in import-export plugin (#15792)
### What? Fixed table formatting in the Import Export plugin documentation where the `exportLimit`, `importLimit`, and `limit` types were not properly styled. ### Why? The previous syntax (`number\|function`) was displaying awkwardly. Changing it to an inline code block (`` `number | function` ``) properly displays the type union without breaking the Markdown table rendering that relies on the pipe (`|`) character. ### How? Updated the types column for `exportLimit`, `importLimit`, and `limit` in [docs/plugins/import-export.mdx](cci:7://file:///Users/mahmoud/Desktop/work/payload/docs/plugins/import-export.mdx:0:0-0:0) to use inline code blocks instead of backslash-escaped pipes. Fixes # -
1 parent 05e818e commit 0dba95a

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

‎docs/plugins/import-export.mdx‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -100,14 +100,14 @@ For smaller datasets or testing, you can run imports and exports synchronously b
100100

101101
## Options
102102

103-
| Property | Type | Description |
104-
| -------------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------- |
105-
| `collections` | array | Collections to include Import/Export controls in. Array of collection configs with per-collection options. Defaults to all. |
106-
| `debug` | boolean | If true, enables debug logging. |
107-
| `exportLimit` | number\|function | Global maximum documents for export operations. Set to `0` for unlimited (default). Per-collection limits take precedence. |
108-
| `importLimit` | number\|function | Global maximum documents for import operations. Set to `0` for unlimited (default). Per-collection limits take precedence. |
109-
| `overrideExportCollection` | function | Function to override the default export collection. Receives `{ collection }` and returns modified collection config. |
110-
| `overrideImportCollection` | function | Function to override the default import collection. Receives `{ collection }` and returns modified collection config. |
103+
| Property | Type | Description |
104+
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------- |
105+
| `collections` | array | Collections to include Import/Export controls in. Array of collection configs with per-collection options. Defaults to all. |
106+
| `debug` | boolean | If true, enables debug logging. |
107+
| `exportLimit` | `number \| function` | Global maximum documents for export operations. Set to `0` for unlimited (default). Per-collection limits take precedence. |
108+
| `importLimit` | `number \| function` | Global maximum documents for import operations. Set to `0` for unlimited (default). Per-collection limits take precedence. |
109+
| `overrideExportCollection` | function | Function to override the default export collection. Receives `{ collection }` and returns modified collection config. |
110+
| `overrideImportCollection` | function | Function to override the default import collection. Receives `{ collection }` and returns modified collection config. |
111111

112112
### Per-Collection Configuration
113113

@@ -121,25 +121,25 @@ Each item in the `collections` array can have the following properties:
121121

122122
### ExportConfig Options
123123

124-
| Property | Type | Description |
125-
| -------------------- | ---------------- | ------------------------------------------------------------------------------------------------ |
126-
| `batchSize` | number | Documents per batch during export. Default: `100`. |
127-
| `disableDownload` | boolean | Disable download button for this collection. |
128-
| `disableJobsQueue` | boolean | Run exports synchronously for this collection. |
129-
| `disableSave` | boolean | Disable save button for this collection. |
130-
| `format` | string | Force format (`csv` or `json`) for this collection. |
131-
| `limit` | number\|function | Maximum documents to export. Set to `0` for unlimited (default). Overrides global `exportLimit`. |
132-
| `overrideCollection` | function | Override the export collection config for this specific target. |
124+
| Property | Type | Description |
125+
| -------------------- | -------------------- | ------------------------------------------------------------------------------------------------ |
126+
| `batchSize` | number | Documents per batch during export. Default: `100`. |
127+
| `disableDownload` | boolean | Disable download button for this collection. |
128+
| `disableJobsQueue` | boolean | Run exports synchronously for this collection. |
129+
| `disableSave` | boolean | Disable save button for this collection. |
130+
| `format` | string | Force format (`csv` or `json`) for this collection. |
131+
| `limit` | `number \| function` | Maximum documents to export. Set to `0` for unlimited (default). Overrides global `exportLimit`. |
132+
| `overrideCollection` | function | Override the export collection config for this specific target. |
133133

134134
### ImportConfig Options
135135

136-
| Property | Type | Description |
137-
| ---------------------- | ---------------- | ------------------------------------------------------------------------------------------------ |
138-
| `batchSize` | number | Documents per batch during import. Default: `100`. |
139-
| `defaultVersionStatus` | string | Default status for imported docs (`draft` or `published`). |
140-
| `disableJobsQueue` | boolean | Run imports synchronously for this collection. |
141-
| `limit` | number\|function | Maximum documents to import. Set to `0` for unlimited (default). Overrides global `importLimit`. |
142-
| `overrideCollection` | function | Override the import collection config for this specific target. |
136+
| Property | Type | Description |
137+
| ---------------------- | -------------------- | ------------------------------------------------------------------------------------------------ |
138+
| `batchSize` | number | Documents per batch during import. Default: `100`. |
139+
| `defaultVersionStatus` | string | Default status for imported docs (`draft` or `published`). |
140+
| `disableJobsQueue` | boolean | Run imports synchronously for this collection. |
141+
| `limit` | `number \| function` | Maximum documents to import. Set to `0` for unlimited (default). Overrides global `importLimit`. |
142+
| `overrideCollection` | function | Override the import collection config for this specific target. |
143143

144144
### Example Configuration
145145

0 commit comments

Comments
 (0)