[RRFC] Add syntaxs support for [!TIP] blockquotes in markdown files in npmjs.com
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 777
- Forks
- 267
- PR merge metrics
- No merged PRs in 30d
Description
Brief:
There are several tags in markdown includes
- [!IMPORTANT]
- [!WARNING]
- [!TIP]
- [!NOTE]
- [!CAUTION]
They can be renderred into some beautiful headers, can we have this feature for each homepage of package in npmjs.com?
Related issue:
[Markdown] An option to highlight a "Note" and "Warning" using blockquote (Beta)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how markdown files are rendered on npmjs.com package homepages and read the linked GitHub discussion about highlighted blockquotes. Define the expected rendering for the listed tags, especially [!TIP], and document the completed behavior before implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100