fastruby / fastruby/points

Show markdown reference for the description block

Aperta
#87 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Feature Request
Lingua principale
Ruby
Stelle
42
Fork
17
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.