styleguidist/react-styleguidist

Configure Sections using markdown files in folders and front-matter

Open

#365 aberto em 29 de mar. de 2017

Ver no GitHub
 (13 comments) (0 reactions) (0 assignees)TypeScript (1.416 forks)github user discovery
help wantedrequest for comments

Métricas do repositório

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

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?

Guia do colaborador

Direção de pesquisa
Veja como o react styleguidist atualmente lida com a configuração de seções. Em seguida, explore a análise de arquivos markdown com front matter usando um loader como markdown with front matter loader ou lendo arquivos diretamente. Considere como integrar isso ao mecanismo de configuração existente.
Pilha de tecnologia
typescriptreactjavascript
Domain
frontend
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.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
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.
Claro
Prerequisites
MarkdownYAMLReact
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60