styleguidist/react-styleguidist

Configure Sections using markdown files in folders and front-matter

Open

#365 ouverte le 29 mars 2017

Voir sur GitHub
 (13 commentaires) (0 réactions) (0 assignés)TypeScript (1 416 forks)github user discovery
help wantedrequest for comments

Métriques du dépôt

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

Description

I know we can configure sections via a custom config.

But wouldn't it be cool if the sections could be generated simply by [index|section].md files in src folders using YAML front matter (https://github.com/matthewwithanm/markdown-with-front-matter-loader)?

---
section: Name of the section
---

# Section description

This would further simplify the configuration. What you think?

Guide contributeur

Direction de recherche
Regardez comment react styleguidist gère actuellement la configuration des sections. Ensuite, explorez l'analyse des fichiers markdown avec front matter en utilisant un loader comme markdown with front matter loader ou en lisant directement les fichiers. Réfléchissez à la façon d'intégrer cela au mécanisme de configuration existant.
Stack technique
typescriptreactjavascript
Domaine
frontend
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.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
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.
Claire
Prérequis
MarkdownYAMLReact
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60