styleguidist/react-styleguidist

Can react-styleguidist support markdown metadata？

Open

#1.361 aberto em 15 de mai. de 2019

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (1.416 forks)github user discovery
enhancementhelp wanted

Métricas do repositório

Stars
 (11.091 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Procure no código fonte do styleguidist onde os arquivos markdown são carregados e analisados, provavelmente no carregador de markdown ou no carregador de exemplos. Em seguida, investigue como expor os metadados do front matter (por exemplo, usando gray matter) e torná los disponíveis para componentes como SectionRenderer através de props ou context.
Pilha de tecnologia
typescriptreact
Domain
developer experiencetooling
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Reactmarkdown parsing
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60