djyde/cusdis

Add markdown syntax explaination

Open

#35 opened on Apr 22, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (291 forks)github user discovery
documentationgood first issuewidget

Repository metrics

Stars
 (2,779 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Cusdis comment is support a subset of Markdown syntax. Should write a document page about it, explain which syntax is support, which is not. And add this document link to the widget, below the reply textarea.

https://github.com/djyde/cusdis/blob/master/service/comment.service.ts#L8-L12

Contributor guide

Research direction
Look at the comment service code to find which Markdown syntax is supported, then create a documentation page explaining it and add a link to the widget.
Tech stack
typescript
Domain
documentationfrontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90