InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Formatting of newlines in gitbook

Offen
#805 6 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

:beetle: Bug
Vorherrschende Sprache
HTML
Sterne
853
Forks
206
Ø Merge
1 T. 23 Std.
Gemergte PRs (30 T.)
2

Beschreibung

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.

Image

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die Pattern-Markdown-Dateien und die in der Issue beschriebene von GitBook gerenderte Seite zu überprüfen, um zu bestätigen, wie einzelne Zeilenumbruchzeichen behandelt werden. Ermittle, ob die Korrektur im Markdown-Inhalt oder in der GitBook-Konfiguration vorgenommen werden muss, und überprüfe anschließend, dass die gerenderten Patterns keine unerwünschten Zeilenumbrüche mehr anzeigen, während beabsichtigte Absätze erhalten bleiben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
markdown
Bereich
documentation
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
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.