fastruby / fastruby/points

Show markdown reference for the description block

Open
#87 0 comments 0 reactions 0 assignees View on GitHub
Feature Request
Dominant language
Ruby
Stars
42
Forks
17
PR merge metrics
No merged PRs in 30d

Description

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)**

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.