[editorial] Inline Hugo front matter

[chalin]

• Fixes [Editorial] Inline Hugo front matter #4029
• Replacement solution for [Editorial] suppress MD041 - First line in a file should be a top-level heading #4021
• Notes & questions:
  • I kept "Hugo front matter used to generate the website version of this page" as a YAML comment. Shall I drop those lines now that it's official Markdown front matter?
  • Because markdownlint actually recognizes front-matter titles, I've disabled that feature so that it doesn't report an error (due to the title also appearing in the page)

/cc @reyang @carlosalberto @svrnm

[chalin]

I'm looking into the markdown-toc GH action failure.

[chalin]

Hmm, the markdown-toc tool seems to be cleaning up more than just the TOC. It strips the comment from the front matter and removes any blank lines between the title and the front matter 🤷🏼‍♂️. I'll commit the change so that you can see.

Yes, I confirm that it's a known issue:

• Why's markdown-toc modifying my front-matter? jonschlinkert/markdown-toc#151

[chalin]

So strange, markdown-toc is also adding blank lines at the end of files!

[chalin]

Ok, well ... due to unresolved bugs in markdown-toc, we can't inline Hugo front matter 🤷🏼‍♂️
Ref.: jonschlinkert/markdown-toc#151 (comment).

[chalin]

I've removed the commits that contained the markdown-toc mangled content. So there should be only one GH action failure, the markdown-toc check.

So, it seems that this can't be merged until markdown-toc is fixed. :-/

[chalin]

I could modify the markdown-toc make rule to temporarily comment out the front matter, but I'm not sure that it's worth it. WDYT @reyang et all?

[jsuereth]

Approved pending TOC fix.

[chalin]

Ok, I'll tackle on the markdown-toc workaround as soon as I can.

[github-actions]

This PR was marked stale due to lack of activity. It will be closed in 7 days.

[chalin]

Nope, not stale, I was OOO.

[chalin]

Heads up that I'm really swamped atm, so I'm unsure when I'll be able to get to this.