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.

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

Layout-engine-specific CLI options should be documented on website #2086

Open
smheidrich opened this issue Sep 8, 2024 · 0 comments
Open

Comments

@smheidrich
Copy link

smheidrich commented Sep 8, 2024

Proposal

It would be nice if layout-engine-specific CLI options such as --dagre-nodesep or --elk-padding were documented in the web docs somewhere so that people can find them when they search for the relevant keywords.

Possible implementations

A very easy way to do this would be to just add the output of d2 layout <ENGINE> for all engines to the CLI manual page.

Of course the "proper" way would be to have a separate page about these somewhere with proper formatting, but that probably only makes sense once that exists for the CLI in general.

Background

I was looking for a way to reduce the padding within nodes, but searching for "padding" on the docs website yields no useful results, making it look like that's not possible.

So I had a look at the issues and found #1740 (comment) which mentions the --dagre-nodesep CLI options, which made me curious if there were other options related to spacing, and indeed, there is --elk-padding for the ELK layout engine, which does exactly what I want.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant