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

Documentation: clarify use of diagram options that act as flags #1469

Merged
merged 1 commit into from
Mar 19, 2023
Merged

Documentation: clarify use of diagram options that act as flags #1469

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 13 additions & 10 deletions docs/modules/setup/pages/diagram-options.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,27 @@ Applies to `blockdiag`, `seqdiag`, `actdiag`, `nwdiag`, `packetdiag` and `rackdi
|Description

|antialias
|_boolean_ +
`true`, *`false`*
|Pass diagram image to anti-alias filter
|_flag_ +
empty string ("")
|Apply anti-alias filter to diagram image +
With flag set, option takes effect.

|no-transparency
|_boolean_ +
*`true`*, `false`
|Do not make transparent background of diagram (PNG only)
|_flag_ +
empty string ("")
|Disable transparent background of diagram (PNG only) +
With flag set, option takes effect.

|size
|_dimension format \{width}x\{height}_ +
ex. `320x240`
|Size of diagram

|no-doctype
|_boolean_ +
`true`, *`false`*
|Do not output doctype definition tags (SVG only)
|_flag_ +
empty string ("")
|Omit doctype definition tag (SVG only) +
With flag set, option takes effect.
|===

== D2
Expand Down Expand Up @@ -83,7 +86,7 @@ ex. `320x240`
|Set a default edge attribute: https://graphviz.org/doc/info/command.html#-E

|layout
|
|_string_ +
*`dot`* +
`neato` +
`fdp` +
Expand Down