Update Handbook Markdown Guide to note the difference between .md and .md.erb
Briefly describe the update
I've been wondering the difference between .md
and .md.erb
files, and couldn't find a definitive answer. Thanks to @dmurph, I was able to get an understanding, and think it'd be good for us to document in the Handbook Markdown Guide.
Notes for the update from the Slack thread:
-
The non-technical answer to this is — always use
md.erb
because it’s more flexible. I wanted to use apartial
in the all-remote pages and a standard Markdown page won’t render Partials (IIRC). So I updated them all tomd.erb
to handle more complex elements like that -
I’m not seeing anything definite in site:about.gitlab.com using my googlefu - closest I found was this: https://about.gitlab.com/handbook/marketing/digital-experience/website/
-
I believe the actual answer is
Name
page.html.md.erb
means: first process ERB, then Markdown, and the end result will be HTML.https://forum.middlemanapp.com/t/erb-markdown-and-partial/1362
-
I’d ask
Michael Preuss
or someone in #digital-experience-team to review to make sure my assumptions here are correct. IIRC I initially addederb
solely to makepartials
work but they may know if there are any other ramifications worth documenting -
Actually, looks like Diana/Susan are the codeowners there, they’d know
👍