Skip to content
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

Add argument to --svg-topurl in help message. #87

Merged
merged 5 commits into from
Nov 28, 2024
Merged

Add argument to --svg-topurl in help message. #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4953924
fix: add version to composer.json
smeghead Nov 28, 2024
95f5da5
fix: add `--svg-toprul` to argument.
smeghead Nov 28, 2024
b931461
fix: Adds a line break to a long horizontal command line.
smeghead Nov 28, 2024
1933776
Update CHANGELOG.md
smeghead Nov 28, 2024
24e26d2
fix: remove version from composer.json
smeghead Nov 28, 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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# CHANGELOG

### Bug fix

* Add argument to `--svg-topurl` in help message.

## v1.4.2 (2024-09-23)

### Features
Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ One of the standout features of this tool is the ability to generate class diagr
To enable this feature, generate the diagrams in SVG format and use the `--svg-topurl` option to specify the base URL for the links:

```shell
$ vendor/bin/php-class-diagram --svg-topurl='https://github.com/your-username/your-repo/blob/main/path/to/source' path/to/php/files
$ vendor/bin/php-class-diagram \
--svg-topurl='https://github.com/your-username/your-repo/blob/main/path/to/source' \
path/to/php/files
```

To embed the SVG diagrams in HTML while preserving the clickable links, use the `embed` or `object` tags instead of `img`. Here’s an example:
Expand Down Expand Up @@ -113,7 +115,7 @@ OPTIONS
--hide-private hide private properties and methods.
--hide-private-properties hide private properties.
--hide-private-methods hide private methods.
--svg-topurl specifies the top URL when displaying the class as a link when outputting in SVG format.
--svg-topurl='url' Specifies the top URL when displaying the class as a link when outputting in SVG format.
--header='header string' additional header string. You can specify multiple header values.
--include='wildcard' include target file pattern. (default: `*.php`) You can specify multiple include patterns.
--exclude='wildcard' exclude target file pattern. You can specify multiple exclude patterns.
Expand Down
2 changes: 1 addition & 1 deletion bin/php-class-diagram
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ OPTIONS
--hide-private hide private properties and methods.
--hide-private-properties hide private properties.
--hide-private-methods hide private methods.
--svg-topurl Specifies the top URL when displaying the class as a link when outputting in SVG format.
--svg-topurl='url' Specifies the top URL when displaying the class as a link when outputting in SVG format.
--header='header string' additional header string. You can specify multiple header values.
--include='wildcard' include target file pattern. (default: `*.php`) You can specify multiple include patterns.
--exclude='wildcard' exclude target file pattern. You can specify multiple exclude patterns.
Expand Down