Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Show markdown reference for the description block

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

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

Đánh giá

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

Hướng nghiên cứu

Issue xác định khối mô tả là điểm bắt đầu nhưng không nêu tệp hoặc bài kiểm thử nào. Hãy bắt đầu bằng cách tìm UI đó và kiểm tra cách nội dung Markdown của nó hiện được kết xuất; so sánh tài liệu tham khảo khi di chuột được đề xuất với chú giải hoặc tài liệu GitHub được liên kết. Được xem là hoàn tất khi người dùng có thể truy cập tài liệu tham khảo Markdown cơ bản, ngắn gọn mà không rời khỏi quy trình làm việc của phần mô tả.

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

Mô tả

Feature Request

https://ombulabs.atlassian.net/browse/DT-264

Branch/Commit:

Main branch.

Describe the feature:

As a <role name>
I want to see a quick reference of some markdown syntax
So I don't have to look for that in other places

I imagine a small (?) element next to the description that, on hover, shows a quick cheat-sheet of the basic for formatting and code blocks.

Problem:

Currently, if you need some syntax reference, you have to google for it or remember it. Also, for example, 4-space indentation looks better than tripple backtick for code blocks, maybe we can suggest to use the former instead in that cheat-sheet.

Resources:

Here in github, we have this legend below the description block, clicking it takes you to a documentation page, we could also do that, linking to this same documtation maybe if we don't want a custom cheat-sheet.

image

I will abide by the code of conduct

Ngôn ngữ chính
Ruby
Star
42
Fork
17
Không có pull request nào được merge trong 30 ngày

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

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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.

Issue khác của fastruby/points

Tất cả issue của fastruby/points

Issue tương tự

Thêm issue về Ruby

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.