Skip to content

Docs: support jsdoc's @link #1545

Description

@homersimpsons

Référence: https://jsdoc.app/tags-inline-link

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

For example, on https://jsr.io/@kysely/kysely/doc/~/AlterTableBuilder#method_addcolumn_0 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.

Unresolved question: I believe the link can point to the "specific" doc page (https://jsr.io/@kysely/kysely/doc/~/CreateTableBuilder#method_addcolumn_0 in this case). But we could imagine that anchor would exists in https://jsr.io/@kysely/kysely/doc and the link could point to theses anchors.

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

    No labels
    No labels

    Type

    No type

    Projects

    • Status
      Needs Triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions