Docs: support jsdoc's `@link`
Maintainer thường phản hồi trong vòng 1 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 65/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- typescript
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu từ URL ví dụ (npmx.dev/package-docs/kysely/v/0.29.6#class-AlterTableBuilder) và định vị route/thành phần phân tích và kết xuất văn bản doc-comment của gói. Làm theo đặc tả @link nội tuyến của jsdoc (https://jsdoc.app/tags-inline-link), bao phủ {@link X}, {@link X|label} và {@linkcode X}. Hoàn tất khi doc của AlterTableBuilder trong kysely hiển thị CreateTableBuilder.addColumn dưới dạng liên kết có thể nhấp, với một test bao phủ việc phân tích thẻ.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- TypeScript
- Star
- 3.6k
- Fork
- 533
- Merge trung bình
- 5 ngày 1 giờ
- Pull request đã merge (30 ngày)
- 36
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của npmx-dev/npmx.dev
-
Enable pnpm strictPeerDependencies checkCó thể đã có người làm @cylewaitforit đã nhận 1 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
Maintainer thường phản hồi trong vòng 1 ngày
-
a11y front
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 67/100
npmx-dev/npmx.dev#2914 · 3 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
front i18n
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 64/100
npmx-dev/npmx.dev#2831 · 1 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày
-
back stale stale-to-close
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
npmx-dev/npmx.dev#2511 · 4 bình luận · 1 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày
-
front needs discussion ux
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
npmx-dev/npmx.dev#2275 · 5 bình luận · 2 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của npmx-dev/npmx.dev
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
kunchenguid/gh-axi#220 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 79/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
Maintainer thường phản hồi trong vòng 1 ngày
-
prerender: wait for env-runner worker readiness before crawlingCó thể đã có người làm @sarankumar1325 đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
Maintainer thường phản hồi trong vòng 1 ngày