npm / npm/documentation

GitHub-Flavored Markdown isn't supported

Open
#1,240 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
712
Forks
4.2k
Avg merge
4d 16h
Merged PRs (30d)
3

Description

See e.g. this package documentation rendered on npmjs.com versus the same thing rendered on GitHub. Admonitions aren't rendered on npmjs.com.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No repository files or tests are named. Compare the npmjs.com package documentation with the GitHub-rendered README linked in the issue, then trace the documentation rendering entry point; done means GitHub-Flavored Markdown admonitions render on npmjs.com as they do on GitHub.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.