styleguidist/react-styleguidist

Configure Sections using markdown files in folders and front-matter

Open

#365 geöffnet am 29. März 2017

Auf GitHub ansehen
 (13 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (1.416 Forks)github user discovery
help wantedrequest for comments

Repository-Metriken

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

Beschreibung

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?

Contributor Guide

Research-Richtung
Schauen Sie sich an, wie react styleguidist derzeit die Abschnittskonfiguration handhabt. Erkunden Sie dann das Parsen von Markdown Dateien mit Front Matter mithilfe eines Loaders wie markdown with front matter loader oder durch direktes Lesen der Dateien. Überlegen Sie, wie dies in den vorhandenen Konfigurationsmechanismus integriert werden kann.
Tech Stack
typescriptreactjavascript
Domain
frontend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
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.
Klar
Voraussetzungen
MarkdownYAMLReact
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60