styleguidist/react-styleguidist

Can react-styleguidist support markdown metadata？

Open

#1.361 geöffnet am 15. Mai 2019

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (1.416 Forks)github user discovery
enhancementhelp wanted

Repository-Metriken

Stars
 (11.091 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

I want to get the metadata of markdown docs，For example，

---
title: componentName
anthor:  John
---

and I can get the metadata in SectionRenderer, just like

{
title: 'componentName',
anthor: 'John'
}

Contributor Guide

Research-Richtung
Suche im Quellcode von styleguidist nach der Stelle, an der Markdown Dateien geladen und geparst werden, wahrscheinlich im Markdown Loader oder im Beispiele Loader. Untersuche dann, wie Front Matter Metadaten (z.B. mit gray matter) offengelegt und über Props oder Context für Komponenten wie SectionRenderer verfügbar gemacht werden können.
Tech Stack
typescriptreact
Domain
developer experiencetooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Reactmarkdown parsing
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60