JSDoc: Support Markdown formatting
Open
Nobody has claimed this yet.
enhancement
language-definitions
- Dominant language
- JavaScript
- Stars
- 13k
- Forks
- 1.4k
- Avg merge
- 15h 36m
- Merged PRs (30d)
- 3
Description
JSDoc descriptions support Markdown formatting but we don't highlight it.
Example:
/**
* @description
* hello world
* ```ts
* export declare type = number;
* ```
* @default 1
*/
var data = 1;
The code block should be highlighted but isn't.
This will likely require significant changes to Markdown.
Contributor guide
No contributing guide indexed for this repository
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
The issue names no files, tests, or entry points; start by locating Prism's JSDoc and Markdown handling. Done means Markdown code blocks inside JSDoc descriptions are highlighted, including the shown TypeScript example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, markdown
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100