elastic / elastic/docs-builder-example

Lines breaks

Open
#7 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
2
Forks
6
PR merge metrics
No merged PRs in 30d

Description

The line breaks work differently than I expected. Per https://github.com/elastic/docs-builder-example/blob/main/docs/source/markup/sundries.md#line-breaks "You can break a paraghraph
using \ at the end of a line."

However when I cut and paste content from the elasticsearch repo, where it seems it was assumed that you had to have a defined line length and content wraps despite that, those EOL were appearing as-is in my output. For example:

```
The latest stable version of {{es}} can be found on the
[Download {{es}}](https://www.elastic.co/downloads/elasticsearch) page. Other
versions can be found on the [Past Releases page](https://www.elastic.co/downloads/past-releases).
```

![Image](https://github.com/user-attachments/assets/8a220ab4-ccb5-47bd-afa3-1ecc7b1a4f0e)

If this is working as designed I think we need to be very clear in the style guide info that what you see in your source file is exactly what appears in the output where line breaks are concerned.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.