remarkjs / remark-breaks Goto Github PK

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Problem

## Line 1
  Line 2

Line 1
Line 2
---------

These don't add <br>. Not sure if I'm using it wrong, works on others eg. unordered list

Would be great to have. Headings use breaks just as much as other nodes do.

Solution

It's a short function, so I did read it, but I don't know how unified, remark etc. work, so I'm guessing the issue is that it visits tree for 'text'

Alternatives

Workaround

# Line 1
# Line 2
<style> h1:nth-child... // of-type...

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Affected packages and versions

lastest (3.0.2)

Link to runnable example

https://stackblitz.com/edit/github-4rc9wa

Steps to reproduce

• Add two spaces at the end of a text inside a table cell and type some text on the next line
  |a|b|c| |--|--|--| |d|e|This paragraph should have a <br>|

Expected behavior

• The text should be rendered with a
  inside the cell

Actual behavior

The text of the 2nd line is considered as a new td in a new tr

Runtime

No response

Package manager

No response

OS

No response

Build and bundle tools

No response

As of now remark (as well as markdown spec) collapse all blank lines between paragraphs.
If you have:

This is a
paragraph.




This is another
paragraph.

You would get:

<p>This is a<br>
paragraph.</p>
<p>This is another<br>
paragraph.</p>```

Would be great if remark-brakes took some flag which would instead result in:

```html
<p>This is a<br>
paragraph.</p>
</br>
</br>
</br>
</br>
<p>This is another<br>
paragraph.</p>

If you can point out what should be done will try to provide PR (if desired),

thanks!

This upsets Yarn 2, currently need this in .yarnrc.yml as a workaround:

packageExtensions:
  "remark-breaks@*":
    dependencies:
      "unist-util-visit": "*"

Skipping the template since this isn't an "unexpected behavior" type of bug.

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Affected packages and versions

3.0.2

Link to runnable example

https://codesandbox.io/s/remark-breaks-bug-example-by1dli

Steps to reproduce

Code Snippet:

import ReactMarkdown from "react-markdown";
import remarkBreaks from "remark-breaks";

const markdown = `
# Test h1 with
a linebreak

Test h1 with
a linebreak
===========

Test h2 with
a linebreak
-----------

## Test h2 with
a linebreak

Test paragraph with
a linebreak
`;

export default function App() {
  return (
    <div className="App">
      <ReactMarkdown remarkPlugins={[remarkBreaks]} children={markdown} />
    </div>
  );
}

Expected behavior

Should render (whitespace added for readability)

<h1>Test h1 with<br />a linebreak</h1>
<h1>Test h1 with<br />a linebreak</h1>

<h2>Test h2 with<br />a linebreak</h2>
<h2>Test h2 with<br />a linebreak</h2>

<p>Test pagaraph with<br />a linebreak</p>

Actual behavior

It instead renders (whitespace added for readability)

<h1>Test h1 with</h1>
<p>a linebreak</p>
<h1>Test h1 with<br />a linebreak</h1>

<h2>Test h2 with<br />a linebreak</h2>
<h2>Test h2 with</h2>
<p>a linebreak</p>

<p>Test pagaraph with<br />a linebreak</p>

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Problem

A definition list should provide lazy continuation in markdown. example doc.

For instance, the package remark-definition-list is a remark plugin for creating definition lists for markdown files supporting lazy continuation like below:

Term 1

: Definition bla bla
with lazy continuation.

So, the definition above in markdown should not break.

Possible Solution

If one of the parent/grand parents type is a descriptiondetails or descriptionterm or descriptionlist, the text node will be omitted without break.

You can have a look at the sample markdown AST for definition lists. here

Maybe, the plugin can provide an option (optional) to provide the parent types in an array which is going to be omitted, like {omit: ["descriptiondetails", "descriptionterm", "descriptionlist"]} for giving flexibility to developers.

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Problem

The transformer can work on the AST without unified. It may be useful to use this as a plain function.

Solution

Move the transformer into a new package mdast-util-breaks. This package would be part of syntax-tree.

Alternatives

I chose the name to match the name remark-breaks, but it may make sense to use something more verbose, e.g.: mdast-util-break-newlines.