InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Formatting of newlines in gitbook

Đang mở
#805 6 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

:beetle: Bug
Ngôn ngữ chính
HTML
Star
853
Fork
206
Merge trung bình
1 ngày 23 giờ
Pull request đã merge (30 ngày)
2

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách xem xét các tệp markdown của pattern và trang được GitBook kết xuất được mô tả trong issue để xác nhận cách các ký tự xuống dòng đơn được xử lý. Xác định xem phần cần sửa nằm trong nội dung markdown hay cấu hình GitBook, sau đó kiểm tra rằng các pattern đã được kết xuất không còn hiển thị các ngắt dòng không mong muốn, đồng thời vẫn giữ nguyên các đoạn văn có chủ đích.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
markdown
Lĩnh vực
documentation
Loại issue
Lỗi
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.