HarshKapadia2 / HarshKapadia2/preview-markdown

Note and Warning support in Markdown

Open
#29 0 comments 0 reactions 0 assignees View on GitHub
enhancement good first issue
Dominant language
JavaScript
Stars
16
Forks
7
PR merge metrics
No merged PRs in 30d

Description

GitHub now renders notes and warnings differently. Please support this behaviour.

The exact colors and looks in light and dark modes will have to be taken into consideration.

The icons appear to be inline SVGs, so they can be directly copied from the Elements tab in the browser DevTools.

Syntax:
```
> **Note** // This is case sensitive. 'notes', 'note' or any other variation will not work.
>
> This is a note.

> **Warning**
>
> This is a warning.
```

Render:
> **Note**
>
> This is a note.

> **Warning**
>
> This is a warning.

Contributor guide

Open the contributing guide

Research direction

Use the provided Note and Warning syntax as the rendering case, and locate the preview's Markdown rendering and styling entry points. Compare the output with GitHub in light and dark modes, including the inline SVG icons; done means exact-case Note and Warning blocks render with matching colors, layout, and icons.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, markdown, react
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.