elastic / elastic/docs-builder-example

Lines breaks

Aperta
#7 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Nessun dato sulla lingua
Stelle
2
Fork
6
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.