ionic-team / ionic-team/ionic-cli

Add component option to docs command

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

Chưa có ai nhận issue này.

triage
Ngôn ngữ chính
TypeScript
Star
2k
Fork
681
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

I started writing my own CLI utility to do this but if the team would be open to adding this I would love to send a PR.

Basically, I would like to add a `component`/`-c` option to the `ionic docs` command that would open the relevant component directly in the documentation. For example, running:

```
ionic docs -c button
```

would open:

```
https://ionicframework.com/docs/api/badge
```

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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.

Hướng nghiên cứu

Bắt đầu từ phần triển khai lệnh `ionic docs` và theo dõi cách các đối số của lệnh được phân tích cũng như cách các URL tài liệu được mở. Làm rõ liệu `-c button` nên được phân giải thành component Button hay component Badge của URL ví dụ, sau đó thêm tùy chọn và xác minh URL kết quả thông qua các bài kiểm thử hiện có của lệnh hoặc bằng cách chạy thủ công.

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

Đánh giá

Công nghệ
typescript
Lĩnh vực
cli
Loại issue
Tính năng
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/100

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.