Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Build jsdoc with HTML output

Aperta
#911 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
javascript

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
JavaScript
Stelle
511
Fork
83
Merge medio
1g 8h
PR unite (30g)
48

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di UI5/cli

Tutte le issue di UI5/cli

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.