Let Your Markdown Breathe! - Remember to insert blank lines between different Markdown elements | /en/2021/06/markdown-breath/

utterances-bot 2022-04-07 19:00:24

Let Your Markdown Breathe! - Remember to insert blank lines between different Markdown elements

https://yihui.org/en/2021/06/markdown-breath/

4 Comments

shannonpileggi 2022-04-07 19:00:24

You are too kind to ping me! It is appreciated nevertheless. 🤗 I think I mentioned this in our now deleted disqus chat, but I do believe I picked up the phrase from another workshop I attended, and I strongly suspect it came from the very wise @mine-cetinkaya-rundel 👑

❤️ 2 ▶

giscus-bot 2022-12-17 06:26:05

Guest *Aaron Simumba* @ 2021-06-10 09:57:05 originally posted:

As Yihui - "After his presentation, I walked up to him, and apologized for the lack of space between him and me since I was standing embarrassingly close to him."
Had this been 2020 onwards, the lack of "social distance" would have been a profound analogy to drive home this point.

PS... one moment, no more blog posts from Yihui, next moment, I find myself with a million posts to binge. Welcome back!

yihui 2022-12-17 06:26:08

Yes, I should have titled this post "Let Your Markdown Keep the Social Distance" :)

And thanks for (binge-)reading! I started writing again a couple of months ago, but I've also started adopting a publishing strategy that I've been using for my Chinese blog. That is, I'll publish (i.e., git commit and push) a batch of posts at once written a while ago. For my Chinese blog, I publish once a year, while I keep writing throughout the year. This is to give me a chance to re-read my posts several times before they become public, assure readers that I won't have anything new on my blog until a year later (so they know they don't need to pay attention or have FOMO), and also force myself into writing more on things that can be read at any time (i.e., not time-sensitive). I'm not sure if someday I'll adopt the exactly same strategy for my English blog. For now, the posts are usually delayed for only one week or two.

Originally posted on 2021-06-10 14:07:34

giscus-bot 2022-12-17 06:26:09

Guest *Liechi Zhang* @ 2021-06-10 14:58:24 originally posted:

I usually put a space between : and ) , otherwise the "mask" seems too tight on the face : ), with less air to breath.

@liechi

yihui 2022-12-17 06:26:09

Perhaps an N95 mask works even better : }

Originally posted on 2021-06-10 15:09:07

giscus-bot 2022-12-17 06:26:10

Guest *Aaron Simumba* @ 2021-06-11 13:06:16 originally posted:

I like the strategy of batch publishing. And the one to two weeks time lag is perfect.

giscus-bot 2022-12-17 06:26:11

Guest *Aaron Simumba* @ 2021-06-11 13:06:49 originally posted:

Let Your Mask Breathe!

giscus-bot 2022-12-17 06:26:06

Guest *TheRandomTexan* @ 2021-06-16 12:38:28 originally posted:

My undergrad biostats students are forever running into this problem. I think it's mainly because--despite the fact they are "science" majors--most of them have ZERO programming experience and are mediocre writers. Shannon's wise exhortation, "Let your markdown breathe!" is just the reminder they need.

Now that I've found your blog, I have a vexing R markdown question. How to I get the language attribute included in the <html> tag at the beginning of my HTML output documents? I need <html lang="en">, but see no option to make that happen, other than doing a hand correction of the HTML file.

yihui 2022-12-17 06:26:12

You can set lang: en in YAML: https://pandoc.org/MANUAL.html#language-variables

Originally posted on 2021-06-16 15:20:16

giscus-bot 2022-12-17 06:26:12

Guest *TheRandomTexan* @ 2021-06-17 16:03:09 originally posted:

D'oh! That's simpler than I could have imagined. Of course, it works like a charm. Thank you for saving me hours of error-prone work. AND for the very quick response!

Back to the main topic. My students are now hearing the mantra "Let your markdown breathe!" in every debugging session and programming assignment. Thanks again for that.

giscus-bot 2022-12-17 06:26:07

Guest *TheRandomTexan* @ 2021-07-05 11:57:04 originally posted:

Another novice question, after "peeling the onion" of the lang attribute. I generate HTML lecture notes and assignments for my course web site using RMarkdown. My university has begun to require HTML content to meet accessibility standards that support screen readers for the visually impaired; RMarkdown-generated HTML doesn't quite conform. My immediate problem: how can I get the "author" and "title" elements to be generated as <h2> level headers instead of <h4> level? While I can certainly edit these by hand, it becomes labor-intensive as I write more content. I'm sure there's a template somewhere for this, but I'm clueless where.

yihui 2022-12-17 06:26:13

The default template is here: https://github.com/rstudio/rmarkdown/blob/master/inst/rmd/h/default.html

Originally posted on 2021-07-14 18:22:15

giscus-bot 2022-12-17 06:26:14

Guest *TheRandomTexan* @ 2021-07-23 15:33:14 originally posted:

Thank you, this lead me to the one"default.html" (among far too many) that is the key to the whole Knit-ing process. A tiny bit of editing, and now I'm standards compliant! As a bonus, I discovered the "abstract" element; a bit touchy, but a great positive addition to my content. Thanks again; you get a shout-out in my endnotes as my YAML Guru.

yihui 2022-12-17 06:26:15

You are welcome. Actually I tend to change the current h4 to h2, since you are definitely not the first one who has mentioned this problem: rstudio/rmarkdown#2176 This might be a breaking change to some people, but I think it will be worth it.

Originally posted on 2021-07-23 16:02:21