umputun/remark42

[documentation] Outdated MarkDown supported features reference

Open

#1,211 opened on Dec 27, 2021

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Go (432 forks)user submission
documentationfrontendgood-first-issuehelp wanted

Repository metrics

Stars
 (5,500 stars)
PR merge metrics
 (Avg merge 7d) (7 merged PRs in 30d)

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.

Contributor guide

Research direction
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.
Tech stack
htmlcss
Domain
documentationfrontendaccessibility
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HTMLCSSMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85