How to render text on new line?

[jaythamke]

Hi,
I want to use markdown flavor of adding new line in our mkdocs pages.

This is a text.  \
Text spills on a new line.

I expect after two spaces and backslash ( \) and return (hitting Enter key) the text on new line should be rendered on the new line in mkdocs pages (as it does in markdown). However it renders on the same line - This is a text. \ Text spills on a new line..

Indeed mkdocs renders a text on new line after two spaces (without backslash) and return, but many IDEs and git pre-commit hooks complains for additional blank spaces at the end of text.

What could be the workaround for this problem?

Thanks and regards,
Jayesh

[facelessuser]

Let's be clear here. The original Markdown spec uses two spaces to put things on a new line, not two spaces and a \.

I do have an extension, that I maintain, that can add newlines with \ called EscapeAll. You just need to enable hardbreak, but then you can force newlines when escaping a newline. Maybe that will get you what you want.

[jaythamke]

Thanks for the reply, I tried escapeall in our documentation. The mkdocs build stage failed. We have following (similar) text.

This is some text. The generation (_i\*XX+1_) is a next generation and the newer generation (_i\*XX+2_) will be advance.

This failed mkdocs build and serve stage with error ERROR - '\*' is not a valid escape sequence. Allowed escape sequences are '\', '|'

Following text without adjustment.

This is some text. The generation (_i*XX+1_) is a next generation and the newer generation (_i*XX+2_) will be advance.

Mkdocs Page Rendering:

This is some text. The generation (iXX+1_) is a next generation and the newer generation (_iXX+2) will be advance.

I have following config for mkdocs markdown extn in mkdcs.yml

markdown_extensions:
    - admonition
    - codehilite:
        guess_lang: false
    - toc:
        permalink: true
    - tables
    - footnotes
    - pymdownx.superfences
    - pymdownx.details
    - pymdownx.escapeall:
        hardbreak: true
    - pymdownx.tabbed:
        alternate_style: true

Could you suggest the fix?
Thanks

[facelessuser]

@jaythamke I am not seeing this issue:

[facelessuser]

I would need more context. Are you using some MkDocs plugins that are choking on this? Other Markdown extensions not listed? Do you have a full traceback of the error? It's just difficult to tell.

What I can say is that we test such cases and that I'm not able to reproduce such errors. I am running the latest Pymdown Extensions.