Skip to content

Use proper Sybil parsers#5

Merged
hynek merged 8 commits intomainfrom
sybil
Jul 25, 2023
Merged

Use proper Sybil parsers#5
hynek merged 8 commits intomainfrom
sybil

Conversation

@hynek
Copy link
Copy Markdown
Owner

@hynek hynek commented Jul 23, 2023

Continuing from #2

So @cjw296 I think this is what you had in mind? It doesn't seem to work and % also isn't a Markdown thing, but a MyST thing if I'm not wrong (I'm trying to sound constructively helpful, not entitled, sorry if I'm failing I'm still traveling).

But I guess I can wrap the % thing in <!-- --> tho if we can make it work.

@cjw296
Copy link
Copy Markdown
Contributor

cjw296 commented Jul 24, 2023

MD reminds me of MySQL in that respect: a billion different slightly incompatible forks ;-)
Does GFM have a way of specifying single-line comments?
This change was requested, does it just need to be a config option?

README.md Outdated

You set it up like this:

% skip: next
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe just % skip: start to cut out the noise and move it down as you get things working?

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried that but it didn't work either.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you remove the % skip: next? I found a bug where a %skip: start followed by a % skip: next disables the % skip: start. I think that nesting should raise an exception so working on that.

@hynek
Copy link
Copy Markdown
Owner Author

hynek commented Jul 24, 2023

Does GFM have a way of specifying single-line comments?
This change was requested, does it just need to be a config option?

I believe everyone just uses HTML comments: https://github.github.com/gfm/#example-648 – so the answer is no.

@cjw296
Copy link
Copy Markdown
Contributor

cjw296 commented Jul 25, 2023

Does GFM have a way of specifying single-line comments?
This change was requested, does it just need to be a config option?

I believe everyone just uses HTML comments: https://github.github.com/gfm/#example-648 – so the answer is no.

Yay! Consistency! I guess skip and other single line comment things on MyST also need to be expressable as:
<!-- skip: next -->?

@hynek
Copy link
Copy Markdown
Owner Author

hynek commented Jul 25, 2023

Does GFM have a way of specifying single-line comments?
This change was requested, does it just need to be a config option?

I believe everyone just uses HTML comments: https://github.github.com/gfm/#example-648 – so the answer is no.

Yay! Consistency! I guess skip and other single line comment things on MyST also need to be expressable as: <!-- skip: next -->?

Yeah, this would be the best. I've solved it using:

<!--
; skip: next
-->

But

<!-- skip: next -->

would obviously be much nicer.

@hynek
Copy link
Copy Markdown
Owner Author

hynek commented Jul 25, 2023

Big success, thank you!

@hynek hynek merged commit a0efd00 into main Jul 25, 2023
@hynek hynek deleted the sybil branch July 25, 2023 07:29
hynek added a commit that referenced this pull request Jul 25, 2023
@cjw296
Copy link
Copy Markdown
Contributor

cjw296 commented Sep 28, 2023

@hynek - so I'm chipping away at things from the Sybil side, I'm actually hoping to "officially" support GH flavoured markdown at some point, and I'd like you ask for your review on that PR if that's okay?

In the meantime, it looks like you're actually using MyST for the docs, can I just check that this commenting pattern works properly on MyST?

% skip: next

@hynek
Copy link
Copy Markdown
Owner Author

hynek commented Sep 28, 2023

What PR do you mean? This one has been merged and Sybil doesn't have a PR that looks related.

I'm using % skip: next throughout and it's working.

@cjw296
Copy link
Copy Markdown
Contributor

cjw296 commented Oct 25, 2023

This PR ;-)
simplistix/sybil#99

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

Successfully merging this pull request may close these issues.

2 participants