Support for code-formatted links
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
Is there a way to code-format the text of a link? I've tried the following options in the playground, and they didn't work.
/**
* This is a {@link http://test.com | `link`}.
*/
/**
* This is a `{@link http://test.com | link}.`
*/
Is this use case currently supported?
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
Start by reproducing both examples in the playground and inspect how code formatting and {@link} syntax are parsed. Determine the intended behavior for code-formatted link text and whether the specification or parser must change; the issue is complete only when the behavior is decided and documented or implemented with coverage for the reported examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100