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

Syntax highlighting methods #386

Closed
GuillermoFidalgo opened this issue Dec 23, 2022 · 1 comment · Fixed by #387
Closed

Syntax highlighting methods #386

GuillermoFidalgo opened this issue Dec 23, 2022 · 1 comment · Fixed by #387
Labels
type:discussion Discussion or feedback about the lesson

Comments

@GuillermoFidalgo
Copy link
Contributor

This maybe more of a question/discussion instead of an issue.
Should we also include the usage of fenced code blocks (i.e. triple backticks ```) in the formatting chapter ?

Also I don't understand what would the

~~~
# my code here
~~~
{: .language-* }

method have over the ``` method?
Is there some additional functionality that it brings ?

@zkamvar zkamvar added the type:discussion Discussion or feedback about the lesson label Jan 3, 2023
@zkamvar
Copy link
Contributor

zkamvar commented Jan 3, 2023

I believe the reason was that the Jekyll-based lessons all use kramdown syntax, and at the time the lesson was written, getting the backtick syntax would have required extra configuration (even though that syntax works now). I have a feeling that it was never updated because a) the official documentation never noted the change and b) the lessons would have retained the old syntax, which would have lead to a disconnect between contributors reading the documentation and the presentation of the actual lessons.

That being said, it's certainly possible to add a callout in that episode noting that the ``` syntax is available (though the release of The Carpentries Workbench in May will render this guide obsolete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:discussion Discussion or feedback about the lesson
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants