umputun/remark42

[documentation] Outdated MarkDown supported features reference

Open

#1,211 创建于 2021年12月27日

在 GitHub 查看
 (0 评论) (1 反应) (0 负责人)Go (5,500 star) (432 fork)user submission
documentationfrontendgood-first-issuehelp wanted

描述

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.

贡献者指南

技术栈
htmlcss
领域
documentationfrontendaccessibility
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
HTMLCSSMarkdown
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
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.
[documentation] Outdated MarkDown supported features reference · umputun/remark42#1211 | Good First Issue