styleguidist/react-styleguidist

Configure Sections using markdown files in folders and front-matter

Open

#365 aperta il 29 mar 2017

Vedi su GitHub
 (13 commenti) (0 reazioni) (0 assegnatari)TypeScript (1416 fork)github user discovery
help wantedrequest for comments

Metriche repository

Star
 (11.091 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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?

Guida contributor

Direzione di ricerca
Guarda come react styleguidist gestisce attualmente la configurazione delle sezioni. Quindi esplora il parsing di file markdown con front matter utilizzando un loader come markdown with front matter loader o leggendo direttamente i file. Considera come integrare questo con il meccanismo di configurazione esistente.
Tech stack
typescriptreactjavascript
Dominio
frontend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
MarkdownYAMLReact
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60