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

Advice for non-biblio/section [[ is not great, consider suggesting \[[ instead #3015

Open
annevk opened this issue Jan 24, 2025 · 2 comments

Comments

@annevk
Copy link
Collaborator

annevk commented Jan 24, 2025

Saw a [[ opening a biblio or section autolink, but couldn't parse the following contents. If you didn't intend this to be a biblio autolink, escape the initial [ as [

It seems that \[ works just as well and would likely match the surrounding style better.

@tabatkins
Copy link
Collaborator

They both work, I just personally prefer escaping in the HTML style as it's more predictable in its effect, and matches how you escape any HTML bits of syntax.

I do admit having to use the numbers isn't great. I wonder if it would be better to allow some Bikeshed-specific escapes, like &bs[; or something. Could probably just allow any three-character escape that starts with bs to be an escape for the third character.

@annevk
Copy link
Collaborator Author

annevk commented Feb 14, 2025

Since this is Markdown-inspired syntax I think sticking with \ is the least surprising to people as you typically also need that elsewhere.

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

No branches or pull requests

2 participants