Docs: support jsdoc's `@link`
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 65/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- typescript
- Bereich
- documentation
Rechercherichtung
Starte von der Beispiel-URL (npmx.dev/package-docs/kysely/v/0.29.6#class-AlterTableBuilder) und finde die Route/die Komponente, die den Doc-Comment-Text von Paketen parst und rendert. Folge der jsdoc-Inline-@link-Spezifikation (https://jsdoc.app/tags-inline-link) und decke {@link X}, {@link X|label} und {@linkcode X} ab. Fertig, wenn das AlterTableBuilder-Doc von kysely CreateTableBuilder.addColumn als klickbaren Link anzeigt, mit einem Test, der das Parsen des Tags abdeckt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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
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
- Read the contribution guide.
- Check existing issues.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 3.6k
- Forks
- 533
- Ø Merge
- 4 T. 1 Std.
- Gemergte PRs (30 T.)
- 39
Entwicklungsumgebung
Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus npmx-dev/npmx.dev
-
feat: add option to reset all settings to defaultsEvtl. vergeben Ein verknüpfter Pull Request ist offen oder bereits gemergt. Offenpending triage
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
Maintainer antworten meist innerhalb von 1 Tag
-
a11y front
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 67/100
npmx-dev/npmx.dev#2914 · 3 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
front i18n
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 64/100
npmx-dev/npmx.dev#2831 · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
back stale stale-to-close
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
npmx-dev/npmx.dev#2511 · 4 Kommentare · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in npmx-dev/npmx.dev
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
awesome-dsh-plugin/awesome-dsh-plugin#9184 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
farion1231/cc-switch#8829 ·
Maintainer antworten meist innerhalb von 1 Tag
-
[core-client] Remove unused hand-maintained transport helpers after the definition-table cutoverOffendoc-audit enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100