Skip to content

Commit 78c4e9b

Browse files
committed
feat: Add filtering options for relationships in documentation
1 parent 0d4f2a6 commit 78c4e9b

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,5 +149,23 @@ classDiagram
149149
SomeClassD <.. SomeClassA: dependency
150150
```
151151
152+
### Filter relationships
153+
You can hide specific relationship types via CSV with `--exclude-relationships`.
154+
155+
- Allowed values (case-insensitive, aliases supported):
156+
- `dependency` | `dependencies` | `dep` | `deps`
157+
- `composition` | `compositions` | `comp`
158+
- `inheritance` | `inheritances` | `extends`
159+
- `realization` | `realizations` | `implements`
160+
161+
Examples
162+
```shell
163+
# Hide dependencies and compositions
164+
$ vendor/bin/mermaid-class-diagram generate --path src --exclude-relationships dependency,composition
165+
166+
# Hide only dependencies
167+
$ vendor/bin/mermaid-class-diagram generate --path src --exclude-relationships dependency
168+
```
169+
152170
## License
153171
The MIT License (MIT). Please see [LICENSE](https://github.com/tasuku43/php-mermaid-class-diagram/blob/main/LICENSE) for more information.

0 commit comments

Comments
 (0)