From 7619e991cf50e408bf5f5664324d2f1d754296ac Mon Sep 17 00:00:00 2001 From: Peter Cock Date: Thu, 19 Mar 2026 02:16:35 +0000 Subject: [PATCH] QMK avoids raw line breaks within paragraphs in Markdown (#26080) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * QMK avoids raw line breaks within paragraphs in Markdown Mentioned in passing during a few of my recent documentation pull requests, eg #26070. * Suggestion during review Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com> --------- Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com> --- docs/documentation_best_practices.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/documentation_best_practices.md b/docs/documentation_best_practices.md index bc64472e24..f84f106c61 100644 --- a/docs/documentation_best_practices.md +++ b/docs/documentation_best_practices.md @@ -14,6 +14,10 @@ Example: This page covers my super cool feature. You can use this feature to make coffee, squeeze fresh oj, and have an egg mcmuffin and hashbrowns delivered from your local macca's by drone. ``` +# Paragraphs + +Do not use hard line breaks within the raw Markdown for each paragraph. These are optional in Markdown, and have no effect on the rendered output. This means each raw paragraph will be a single long line in your editor (best viewed with line wrapping enabled). + # Headings Your page should generally have multiple "H1" headings. Only H1 and H2 headings will included in the Table of Contents, so plan them out appropriately. Excess width should be avoided in H1 and H2 headings to prevent the Table of Contents from getting too wide.