mafintosh / mafintosh/node-modules

Render descriptions as markdown

Open
#8 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
126
Forks
15
PR merge metrics
No merged PRs in 30d

Description

Perhaps we should render descriptions as markdown since some authors already put markdown inside it. See [this search](http://node-modules.com/search?q=macgyver) for reference. @freeall what is your opinion on this?

Contributor guide

No contributing guide indexed for this repository

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 file or test is named. Start by tracing where module descriptions are rendered and compare the current output with the linked search reference. Done means descriptions containing markdown render consistently, with the expected behavior covered by an appropriate test.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.