feat: List external dependencies in documentation

Aperta
#3,915 5 commenti 2 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
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Inizia dalla documentazione di custom-docs e dal riferimento a JsonDocsComponent collegati nell’issue, quindi traccia il modo in cui la documentazione delle dipendenze include attualmente i componenti delle librerie. Definisci come un array di whitelist o un glob debba selezionare i componenti esterni e aggiorna l’elenco delle dipendenze e il grafo Mermaid; il lavoro è completato quando l’esempio ion-* produce ion-badge in entrambe le sezioni.

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

Descrizione

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.

Lingua principale
TypeScript
Stelle
13.2k
Fork
865
Merge medio
2g 16h
PR unite (30g)
29

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 stenciljs/core

Tutte le issue di stenciljs/core

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.