umputun/remark42

[documentation] Outdated MarkDown supported features reference

Open

#1 211 ouverte le 27 déc. 2021

Voir sur GitHub
 (0 commentaires) (1 réaction) (0 assignés)Go (5 500 stars) (432 forks)user submission
documentationfrontendgood-first-issuehelp wanted

Description

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.

Guide contributeur

Stack technique
htmlcss
Domaine
documentationfrontendaccessibility
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
HTMLCSSMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85
Direction de recherche
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.