Formatting of newlines in gitbook
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 35/100
- Type d'issue
- Bug
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- markdown
- Domaine
- documentation
Piste de recherche
Commencez par examiner les fichiers markdown des patterns et la page rendue par GitBook décrite dans l’issue afin de confirmer la manière dont les caractères de nouvelle ligne simples sont traités. Déterminez si la correction doit être apportée au contenu markdown ou à la configuration de GitBook, puis vérifiez que les patterns rendus n’affichent plus de sauts de ligne indésirables tout en préservant les paragraphes prévus.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- HTML
- Étoiles
- 853
- Forks
- 206
- Merge moyen
- 1 j 23 h
- PR mergées (30 j)
- 2
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de InnerSourceCommons/InnerSourcePatterns
-
community metrics
InnerSourceCommons/InnerSourcePatterns#935 · 1 personne assignée ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#934 · 1 personne assignée ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#922 · 1 personne assignée ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#921 · 1 personne assignée ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#915 · 1 personne assignée ·
Toutes les issues de InnerSourceCommons/InnerSourcePatterns
Issues similaires
-
agent-ready documentation needs-triage
Difficulté 1/5 1-3 heures Accessibilité débutants 88/100
-
untriaged
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
dotnet/dotnet-api-docs#13095 ·
-
documentation
Difficulté 1/5 Moins d'une heure Accessibilité débutants 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 92/100
-
refactor
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100