Skip to content

Formatting of newlines in gitbook #805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
spier opened this issue Mar 27, 2025 · 0 comments
Open

Formatting of newlines in gitbook #805

spier opened this issue Mar 27, 2025 · 0 comments
Labels
🪲 Bug Bug - something that seems to be broken

Comments

@spier
Copy link
Member

spier commented Mar 27, 2025

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

@spier spier added the 🪲 Bug Bug - something that seems to be broken label Mar 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🪲 Bug Bug - something that seems to be broken
Projects
None yet
Development

No branches or pull requests

1 participant