umputun/remark42

[documentation] Outdated MarkDown supported features reference

Open

#1.211 geöffnet am 27. Dez. 2021

Auf GitHub ansehen
 (0 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Go (5.500 Stars) (432 Forks)user submission
documentationfrontendgood-first-issuehelp wanted

Beschreibung

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.

Contributor Guide

Tech Stack
htmlcss
Domain
documentationfrontendaccessibility
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
HTMLCSSMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85
Research-Richtung
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.