documentationjs / documentationjs/documentation

Undesirable escaping of trailing backslashes

Open
#1,218 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

Unfortunately, `documentation` escapes trailing backslashes that are meant for intentional line breaks.

* What version of documentation.js are you using?:
* version 9.3.1

* How are you running documentation.js (on the CLI, Node.js API, Grunt, other?):
* CLI: `npx documentation readme --section API index.js`

> `README.md` before
```md
Line 1\
Line 2

## API
```

> `README.md` after
```md
Line 1\\
Line 2

## API
[..]
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.