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

Jump to bottom

Using <> for required args causes breakage in certain markdown renderers #15

Closed
jacobdeichert opened this issue Jul 18, 2019 · 0 comments · Fixed by #16
Closed

Using <> for required args causes breakage in certain markdown renderers #15

jacobdeichert opened this issue Jul 18, 2019 · 0 comments · Fixed by #16
Labels
bug Something isn't working

Comments

@jacobdeichert
Copy link
Owner

jacobdeichert commented Jul 18, 2019 •
edited
Loading

Source:

### serve <port>

Rendered:

serve

There's a temporary workaround: use an underscore in your arg name.

Source:

### serve <serve_port>

Rendered:

serve <serve_port>

Long-term solution

I was going to use [] for [optional] args.

Maybe [[required]]?

Or <$required> and [$optional]?

Reported on twitter
@jacobdeichert jacobdeichert added the bug Something isn't working label Jul 18, 2019
jacobdeichert added a commit that referenced this issue Jul 19, 2019
@jacobdeichert
Change required arguments to use (round_brackets) instead of <angle_b…
b9ea0e4 
…rackets>

Fixes #15

Although it's quite obvious, I didn't even think about angle brackets causing a problem with renderers. I thought I saw them working within headings and not being parsed as html...

Round brackets work nice.
[square_brackets] will be used for optional args.
@jacobdeichert jacobdeichert mentioned this issue Jul 19, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

BREAKING CHANGE: Change required arg syntax jacobdeichert/mask
1 participant
@jacobdeichert