styleguidist/react-styleguidist

Configure Sections using markdown files in folders and front-matter

Open

#365 opened on Mar 29, 2017

View on GitHub
 (13 comments) (0 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
help wantedrequest for comments

Repository metrics

Stars
 (11,091 stars)
PR merge metrics
 (PR metrics pending)

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?

Contributor guide

Research direction
Look at how react styleguidist currently handles section configuration. Then explore parsing markdown files with front matter using a loader like markdown with front matter loader or by reading files directly. Consider how to integrate this with the existing config mechanism.
Tech stack
typescriptreactjavascript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
MarkdownYAMLReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60