fastruby / fastruby/points

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
Feature Request
Ngôn ngữ chính
Ruby
Star
42
Fork
17
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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

**Branch/Commit:**

Main branch.

**Describe the feature:**

> **As a \**
> **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](https://user-images.githubusercontent.com/188464/136452385-a8d84526-c09a-4521-af49-92887ae3ec93.png)

**I will abide by the [code of conduct](CODE_OF_CONDUCT.md)**

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

Đánh giá

Issue này chưa được đánh giá.

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.