ember-learn / ember-learn/ember-jsonapi-docs

Code blocks to support file titles

Aperta
#34 1 commento 1 reazione 0 assegnatari Vedi su GitHub
Lingua principale
JavaScript
Stelle
10
Fork
11
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

the ember.js guides support defining a file name with its path as in https://github.com/emberjs/ember.js/blob/04ac480e923ab7f345e30b7aad683bea2ffb7193/packages/ember-glimmer/lib/component.js#L72 and this file path shows up in the code block's title. The API docs fails to do this because the html generated by this tool doesn't support it. We need to add support for the same.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Usa l'esempio delle guide di Ember.js in packages/ember-glimmer/lib/component.js come comportamento previsto, quindi traccia il modo in cui questo strumento genera l'HTML per i blocchi di codice della documentazione API. Aggiungi il supporto per visualizzare i percorsi dei file come titoli dei blocchi di codice e verifica che la documentazione generata corrisponda al comportamento delle guide.

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

Valutazione

Stack tecnologico
javascript
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.