Skip to content

Docs: support jsdoc's @link #3279

Description

@homersimpsons

Describe the feature

Reference: https://jsdoc.app/tags-inline-link

Currently NPMX displays package documentation (which is great) but it does not support @link jsdoc tag.

For example, https://npmx.dev/package-docs/kysely/v/0.29.6#class-AlterTableBuilder is generated from:
https://github.com/kysely-org/kysely/blob/b9674df67734fb7a68a2a49bf5b1754a16776481/src/schema/alter-table-builder.ts#L401-L408

Image

So there should be a link on CreateTableBuilder.addColumn.

I found this after:

Additional information

  • Would you be willing to help implement this feature?

Final checks

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    pending triageNew issue waiting for initial maintainer triage

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions