Docs: support jsdoc's `@link`
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 65/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- typescript
调研方向
从示例 URL(npmx.dev/package-docs/kysely/v/0.29.6#class-AlterTableBuilder)出发,定位解析并渲染包 doc-comment 文本的路由/组件。遵循 jsdoc 内联 @link 规范(https://jsdoc.app/tags-inline-link),覆盖 {@link X}、{@link X|label} 和 {@linkcode X}。当 kysely 的 AlterTableBuilder 文档将 CreateTableBuilder.addColumn 显示为可点击链接,且有覆盖该标签解析的测试时即算完成。
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- TypeScript
- 星标
- 3.6k
- 派生
- 533
- 平均合并
- 5 天 1 小时
- 30 天内合并 PR
- 36
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
npmx-dev/npmx.dev 的其他 Issue
-
Enable pnpm strictPeerDependencies check可能已有人在做 @cylewaitforit 于 1 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复
-
a11y front
难度 2/5 1-3 小时 新手友好度 67/100
npmx-dev/npmx.dev#2914 · 3 条评论 ·
维护者通常 1 天内回复
-
front i18n
难度 2/5 1-3 小时 新手友好度 64/100
npmx-dev/npmx.dev#2831 · 1 个 reaction ·
维护者通常 1 天内回复
-
back stale stale-to-close
难度 2/5 1-3 小时 新手友好度 62/100
npmx-dev/npmx.dev#2511 · 4 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
front needs discussion ux
难度 2/5 1-3 小时 新手友好度 65/100
npmx-dev/npmx.dev#2275 · 5 条评论 · 2 个 reaction ·
维护者通常 1 天内回复
查看 npmx-dev/npmx.dev 的全部 Issue
相似的 Issue
-
Add: Pbs Kids未关闭check:passed streams:add
难度 2/5 1-3 小时 新手友好度 67/100
维护者通常 2 天内回复
-
maintanance
难度 2/5 1-3 小时 新手友好度 76/100
inmanta/web-console#7583 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 70/100
deltachat/deltachat-desktop#6881 · 1 条评论 ·
维护者通常 3 天内回复
-
[Bug Report][3.13.7] VDataTable with select-strategy="single" shows select-all checkbox in mobile mode可能已有人在做 @lazerg 今天认领。 未关闭S: triage
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
phivk/rubiks-lab#33 ·
维护者通常 1 天内回复