elastic / elastic/docs-builder-example

Lines breaks

Offen
#7 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Keine Sprachdaten
Sterne
2
Forks
6
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Lies zuerst den Abschnitt zu Zeilenumbrüchen in den verlinkten docs/source/markup/sundries.md, und vergleiche dann das dort dokumentierte Verhalten von Backslashes mit dem eingefügten Beispiel für umbrochenen Text und der angehängten Ausgabe. Erledigt ist die Aufgabe, wenn die beabsichtigte Behandlung von Zeilenumbrüchen im Quelltext bestätigt ist und die Styleguide-Richtlinien klar erklären, ob das Umbrechen des Quelltexts in der gerenderten Ausgabe erscheint.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.