Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Build jsdoc with HTML output

Đang mở
#911 0 bình luận 0 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
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
javascript
Lĩnh vực
documentation, tooling

Hướng nghiên cứu

The issue names the build jsdoc task and generated api.json files but no source file or test. Start by tracing that task and the api.json flow; done would be a documented way to consume the files or a defined HTML-output or plugin path, with validation for the chosen behavior.

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

Mô tả

Hello,

I'm currently trying to gather our companies custom UI5 implementations in reusable libraries and host an internal API documentation for them.

I found the "build jsdoc" option to build documentation alongside the libraries but it only outputs api.json files which somehow should be able to be inserted into the UI5 SDK and viewed there?! But there is no documentation on how to do that either.

Are there plans to include a HTML output to the build jsdoc task or a custom plugin for jsdoc itself to support UI5 Syntax?
On the other hand a guide on how to handle the generated api.json files would help too i guess.

Ngôn ngữ chính
JavaScript
Star
511
Fork
83
Merge trung bình
1 ngày 8 giờ
Pull request đã merge (30 ngày)
48

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 UI5/cli

Tất cả issue của UI5/cli

Issue tương tự

Thêm issue về JavaScript

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.