ember-learn / ember-learn/ember-jsonapi-docs
Code blocks to support file titles
- Vorherrschende Sprache
- JavaScript
- Sterne
- 10
- Forks
- 11
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Rechercherichtung
Verwende das Beispiel aus den Ember.js-Guides in packages/ember-glimmer/lib/component.js als erwartetes Verhalten und verfolge anschließend, wie dieses Tool HTML für Codeblöcke in der API-Dokumentation generiert. Füge Unterstützung dafür hinzu, dass Dateipfade als Titel von Codeblöcken erscheinen, und überprüfe, dass die generierte Dokumentation dem Verhalten der Guides entspricht.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100