Skip to content

Exclude #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 21, 2024
Merged

Exclude #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eae740e
Updates the code that reads files to take into account a list of excl…
cesarParra Sep 21, 2024
8fbb1d5
Updates the code that reads files to take into account a list of excl…
cesarParra Sep 21, 2024
3593aca
Refactorings
cesarParra Sep 21, 2024
4cdae27
Documenting how to exclude files from being documented.
cesarParra Sep 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,23 @@ export default defineMarkdownConfig({
});
```

### Excluding Files from Being Documented

You can exclude one or multiple files from being documented by providing a list of glob patterns to
the `exclude` property in the configuration file.

```typescript
import { defineMarkdownConfig } from "@cparra/apexdocs";

export default defineMarkdownConfig({
sourceDir: 'force-app',
targetDir: 'docs',
scope: ['global', 'public'],
exclude: ['**/MyClass.cls', '**/MyOtherClass.cls'],
...
});
```

### Configuration Hooks

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