sourcegraph/sourcegraph-public-snapshot

Improve rendering of readme/markdown files

Open

#60,431 opened on Feb 12, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Go (1,374 forks)auto 404
good first issue

Repository metrics

Stars
 (10,290 stars)
PR merge metrics
 (PR metrics pending)

Description

Compare production vs prototype:

Prod:

Image

Prototype:

Image

What stands out:

  • Syntax highlighting (although it seems to work running the prototype locally)
  • Header underlines
  • Link anchors

Most of the styling is in Markdown.module.scss.

Contributor guide

Research direction
Examine the Markdown.module.scss file to identify missing or incorrect styles for syntax highlighting, header underlines, and link anchors. Compare with the prototype screenshots and consider using browser developer tools to inspect the differences.
Tech stack
typescript
Domain
frontend
Issue type
Feature
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.
1-2 days
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
CSSSCSS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65