Skip to content

Commit a726525

Browse files
authored
Exclude (#181)
Updates the code that reads files to take into account a list of excluded glob patterns
1 parent fa40111 commit a726525

File tree

12 files changed

+260
-146
lines changed

12 files changed

+260
-146
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,23 @@ export default defineMarkdownConfig({
219219
});
220220
```
221221

222+
### Excluding Files from Being Documented
223+
224+
You can exclude one or multiple files from being documented by providing a list of glob patterns to
225+
the `exclude` property in the configuration file.
226+
227+
```typescript
228+
import { defineMarkdownConfig } from "@cparra/apexdocs";
229+
230+
export default defineMarkdownConfig({
231+
sourceDir: 'force-app',
232+
targetDir: 'docs',
233+
scope: ['global', 'public'],
234+
exclude: ['**/MyClass.cls', '**/MyOtherClass.cls'],
235+
...
236+
});
237+
```
238+
222239
### Configuration Hooks
223240

224241
When defining a `.js` or `.ts` configuration file, your object export can also make use

0 commit comments

Comments
 (0)