Handling Metadata in Markdown Files

60 views
Skip to first unread message

Edward Ost

unread,
Jun 21, 2023, 2:00:26 PM6/21/23
to codelab-authors
Is there a way to effectively comment out the metadata so that when it renders in just regular markdown, e.g. on Github wiki, it does not show a bunch of lines merged together?

I tried commenting out with the usual html <-- and > and it works in the github markdown renderer but claat complains.

Marc Cohen

unread,
Aug 21, 2023, 2:54:45 PM8/21/23
to Edward Ost, codelab-authors
Have you tried surrounding the markdown with <pre> ...  </pre> tags (or code tags)?   I haven't tested this but it might work because markdown is a superset of html.

On Wed, 21 Jun 2023 at 14:00, Edward Ost <edwar...@gmail.com> wrote:
Is there a way to effectively comment out the metadata so that when it renders in just regular markdown, e.g. on Github wiki, it does not show a bunch of lines merged together?

I tried commenting out with the usual html &lt;-- and &gt; and it works in the github markdown renderer but claat complains.

--
You received this message because you are subscribed to the Google Groups "codelab-authors" group.
To unsubscribe from this group and stop receiving emails from it, send an email to codelab-autho...@googlegroups.com.
To view this discussion on the web, visit https://groups.google.com/d/msgid/codelab-authors/40490bbe-7446-4e06-a37c-c372803a09a3n%40googlegroups.com.


--
Marc Cohen (he/him)
Web: mco.dev

Q: Why is this email three sentences or less?

Michael Vorburger

unread,
Oct 28, 2023, 6:16:18 PM10/28/23
to codelab-authors
> comment out the metadata so that when it renders in just regular markdown, e.g. on Github wiki, it does not show a bunch of lines merged together?

I suspect the "correct" solution here may be https://github.com/googlecodelabs/tools/issues/877 to be able use YAML Front Matter as a kind of Header in Markdown.

This would require someone make a contribution with a code change to support this in the future.

Reply all
Reply to author
Forward
0 new messages