elastic / elastic/docs-builder-example

Lines breaks

Abierto
#7 3 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Sin datos de lenguaje
Estrellas
2
Forks
6
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Lee primero la sección sobre saltos de línea de los documentos enlazados docs/source/markup/sundries.md y, después, compara su comportamiento documentado de la barra invertida con el ejemplo de texto ajustado pegado y la salida adjunta. Se considera terminado cuando se haya confirmado el tratamiento previsto de los saltos de línea del código fuente y las directrices de la guía de estilo expliquen claramente si el ajuste de línea del código fuente aparece en la salida renderizada.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.