Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Show markdown reference for the description block

Aperta
#87 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
markdown, ruby
Ambito
frontend

Direzione di ricerca

La issue identifica il blocco della descrizione come punto di ingresso, ma non indica file né test. Inizia individuando questa UI e verificando come viene attualmente eseguito il rendering del suo contenuto Markdown; confronta il riferimento hover proposto con la legenda o la documentazione GitHub collegata. Il lavoro è completato quando gli utenti possono accedere a un riferimento Markdown di base e conciso senza lasciare il flusso di lavoro della descrizione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Ruby
Stelle
42
Fork
17
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di fastruby/points

Tutte le issue di fastruby/points

Issue simili

Altre issue su Ruby

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.