Consider using markdown.extensions.nl2br

[robscott]

One of the common frustrations with mkdocs-material is how new lines are handled. Some examples:

Will not be rendered as a list:

Paragraph text
* List
* Item

Will be rendered as a list:

Paragraph text

* List
* Item

This is a particular pain point in #129 where we're adding generated API reference docs using https://github.com/elastic/crd-ref-docs that are running into this problem. This has also been a recurring pain point in Gateway API documentation, with far too many lists missing the correct line breaks and therefore not being rendered correctly.

If we were to enable the markdown.extensions.nl2br extension, the above problems would go away, but in their place we'd get a different one. It's common to add line breaks in markdown to break up paragraphs for simpler code review and editing, for example, wrapping at 80 chars. If we do this, it creates a strange effect:

Before extension:

After extension:

Markdown source:

Gateway API Inference Extension is an official Kubernetes project focused on
extending [Gateway API](https://gateway-api.sigs.k8s.io/) with inference
specific routing extensions.

The overall resource model focuses on 2 new inference-focused
[personas](/concepts/roles-and-personas) and corresponding resources that
they are expected to manage:

[robscott]

/kind documentation

[kfswain]

I prefer dealing with the newline vs the odd wrapping. WDYT?

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale