styleguidist/react-styleguidist

Can react-styleguidist support markdown metadata？

Open

#1 361 ouverte le 15 mai 2019

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)TypeScript (1 416 forks)github user discovery
enhancementhelp wanted

Métriques du dépôt

Stars
 (11 091 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

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'
}

Guide contributeur

Direction de recherche
Cherchez dans le code source de styleguidist où les fichiers markdown sont chargés et analysés, probablement dans le chargeur markdown ou le chargeur d'exemples. Ensuite, étudiez comment exposer les métadonnées front matter (par exemple en utilisant gray matter) et les rendre disponibles à des composants comme SectionRenderer via des props ou le contexte.
Stack technique
typescriptreact
Domaine
developer experiencetooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Reactmarkdown parsing
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60