InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Formatting of newlines in gitbook

未关闭
#805 6 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

:beetle: Bug
主要语言
HTML
星标
853
派生
206
平均合并
1 天 23 小时
30 天内合并 PR
2

描述

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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先检查 pattern markdown 文件以及 issue 中描述的 GitBook 渲染页面,以确认单个换行符的处理方式。确定修正应属于 markdown 内容还是 GitBook 配置,然后验证渲染后的 pattern 不再显示不需要的换行,同时保留预期的段落。

由索引模型根据 Issue 内容生成。

评估

技术栈
markdown
领域
documentation
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。