feat: List external dependencies in documentation

Đang mở
#3,915 5 bình luận 2 reaction 0 người được giao Xem trên GitHub

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ó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với tài liệu custom-docs và tài liệu tham chiếu JsonDocsComponent được liên kết trong issue, sau đó truy vết cách tài liệu về dependency hiện bao gồm các library component. Xác định cách một whitelist array hoặc glob sẽ chọn các external component, rồi cập nhật danh sách dependency và biểu đồ Mermaid; hoàn tất khi ví dụ ion-* tạo ra ion-badge trong cả hai phần.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Feature: Want this? Upvote it!
Prerequisites
Describe the Feature Request

We have multiple libraries of web components, when compiling the documentation it currently only lists any component that is part of the library and not external components being used.

It would be nice if you could somehow whitelist an array or glob that can be used when documenting dependencies of your component.

Describe the Use Case

<my-component> contains an <ion-badge>. If I said I want the dependency docs to include any component I use that contains "ion-*" then I would expect the documentation to say:

Depends on
  • ion-badge
Graph
graph TD;
  my-component --> ion-badge

I tried to implement this using custom-docs and the JsonDocsComponent but it didn't seem possible.

Ngôn ngữ chính
TypeScript
Star
13.2k
Fork
865
Merge trung bình
2 ngày 16 giờ
Pull request đã merge (30 ngày)
29

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của stenciljs/core

Tất cả issue của stenciljs/core

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.