InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Formatting of newlines in gitbook
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- HTML
- Estrellas
- 853
- Forks
- 206
- Merge medio
- 1 d 23 h
- PR fusionados (30 d)
- 2
Descripción
gitbook is the tool that we use to host https://patterns.innersourcecommons.org.
gitbook has (recently) changed the way that newline characters (\n) in our markdown files are rendered.
Previously a single newline character did not generate a line break.
That meant that we could format our pattern files like below to allow for easier line-based commenting when reviewing patterns.
There's a central project that everyone depends on.
What a great candidate for InnerSource!
Unfortunately, the project has grown organically, with various contributions and additions slapped on haphazardly.
Recently gitbook made change in this rendering logic. Now such text in markdown is rendered exactly as shown i.e. each newline in the markdown also leads to a line break in the rendered HTML. This does not look great. See screenshot below.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza revisando los archivos markdown de patrones y la página renderizada por GitBook descrita en el issue para confirmar cómo se gestionan los caracteres de salto de línea individuales. Identifica si la corrección corresponde al contenido markdown o a la configuración de GitBook y, después, verifica que los patrones renderizados ya no muestren saltos de línea no deseados, preservando los párrafos previstos.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- markdown
- Área
- documentation
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100