InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Formatting of newlines in gitbook
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 853
- Forks
- 206
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 2
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the pattern markdown files and the GitBook-rendered page described in the issue to confirm how single newline characters are handled. Identify whether the correction belongs in the markdown content or GitBook configuration, then verify that the rendered patterns no longer show unwanted line breaks while preserving intended paragraphs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100