Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for {@linkcode}, {linkplain} tags and clever links, monospace links options #85

Closed
zanerock opened this issue Aug 11, 2024 · 1 comment

Comments

@zanerock
Copy link

zanerock commented Aug 11, 2024

The standard jsdoc spec defnies support for monospace and plain text link formatting which is currently missing from jsdoc-to-markdown. (See jsdoc {@link} page.)

To match the jsdoc links, let's add {@linkcode} (which are rendered in monospace) and {@linkplain} (which are rendered in plain text) tags as well as 'clever links' and 'monospace links' options. When 'clever links' is true, then links are rendered in monospace unless the link target is a URL (e.g., links to functions, modules, classes, etc. are rendered in monospace). When 'monospace links' is true, then {@link} tags are rendered in monospace. The 'monospace links' options is ignored if 'clever links' is true.

Support for setting the options from the command line is proposed in jsdoc-to-markdown#301.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

2 participants