umputun/remark42

[documentation] Outdated MarkDown supported features reference

Open

Aperta il 27 dic 2021

Vedi su GitHub
 (0 commenti) (1 reazione) (0 assegnatari)Go (5500 star) (432 fork)user submission
documentationfrontendgood-first-issuehelp wanted

Descrizione

As pointed out in https://github.com/umputun/remark42/discussions/1208, remark42 supports GitHub-Markdown-style spoiler and details tags but it's not reflected in the page which is referenced for MarkDown help (example from demo site): we should update it with more details on which MarkDown you can use.

Also, that page doesn't support a dark theme when the rest of remark42 web does, some CSS adjustment should fix that.

Guida contributor

Tech stack
htmlcss
Dominio
documentationfrontendaccessibility
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
under 1 hour
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
HTMLCSSMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85
Direzione di ricerca
The issue references the discussion #1208 and points to the markdown help.html template file (frontend/templates/markdown help.html). Update it to document the supported GitHub Markdown style spoiler and details tags. Additionally, add CSS to support dark theme, ensuring the help page matches the rest of the site. Check the linked demo page for current appearance and test locally.