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

Docs: Improve readability of values for flags in markdown #136

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tordans
Copy link
Contributor

@tordans tordans commented Aug 28, 2023

I want to propose to roll out the change showecased in this PR to the whole readme.

My issue is, that I find the current formatting where the example value is italic but not part of the <code> tag very hard to read.

I propose to use some other way to signal that som strings are placeholder text and wrap the whole segment as a code block.

Before
Bildschirm­foto 2023-08-28 um 11 54 58
After
Bildschirm­foto 2023-08-28 um 11 54 43

After:

I picked <example_value>, but other wrappers would be possible to, of course.


I did not do this for the whole readme, yet, in order to first get feedback if this PR would be welcome.

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

Successfully merging this pull request may close these issues.

1 participant