styleguidist/react-styleguidist

Can react-styleguidist support markdown metadata？

Open

#1,361 opened on May 15, 2019

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
enhancementhelp wanted

Repository metrics

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

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

Contributor guide

Research direction
Look for where markdown files are loaded and parsed in the styleguidist source code, likely in the markdown loader or in the examples loader. Then investigate how to expose front matter metadata (e.g., using gray matter) and make it available to components like SectionRenderer through props or context.
Tech stack
typescriptreact
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
Mostly clear
Prerequisites
Reactmarkdown parsing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60