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

Support jsdoc link types and settings #86

Closed

Conversation

zanerock
Copy link

Updates link processing logic to adds support for jsdoc style {@linkplain} and {@linkcode} tags as well as DmdOptions['clever-links'] and DmdOptions['monospace-links'] options per jsdoc specification. Also updates tests and function documentation.

See also jsdoc-to-markdown pull request #302.

Closes #85

@75lb
Copy link
Member

75lb commented Aug 26, 2024

PR looks pretty complete, thanks.. will look into it..

@75lb
Copy link
Member

75lb commented Aug 28, 2024

I merged this PR locally and had a play with it.. Could you check the 0-src.js (source) and 3-dmd.md (dmd output) files in these two folders and confirm whether they look correct or not?

Cheers!

@zanerock
Copy link
Author

Good idea with the examples. It looks correct to me. With '--clever-links', {@link ...} renders the URL plain and the code ref in monospace. And with '--monospace-links', {@link ...} renders monospace in both cases. (And {@linkplain ...} and {@linkcode ...} behave as advertised.

@75lb
Copy link
Member

75lb commented Aug 29, 2024

Merged, see jsdoc2md/jsdoc-to-markdown#301

@75lb 75lb closed this Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Add support for {@linkcode}, {linkplain} tags and clever links, monospace links options
2 participants