Ambiente de Desenvolvimento de Componentes de Reacto Isolado com um Guia de Estilo Vivo
O React StyleGuidist é um ambiente de desenvolvimento de componentes com servidor de desenvolvimento recarregado a quente e um guia de estilo de vida que você pode compartilhar com sua equipe. Ele lista propTypes de componentes e mostra exemplos de uso ao vivo e editáveis com base em arquivos de marcação. Confira o guia de estilo de demonstração .
Uso
- Introdução: Instale e execute o StyleGuidist
- Documentando componentes: como escrever documentação
- Localizando componentes: Point StyleGuidist para seus componentes do React
- Configurando Webpack: Tell StyleGuidist como carregar seu código
- Livro de receitas: Como resolver tarefas comuns com o StyleGuidist
Documentação avançada
- Configuração
- Comandos e opções da CLI
- Node.js API
Exemplos
- Guia de estilo básico, fonte
- Guia de estilo com seções, fonte
- Guia de estilo com estilos personalizados, fonte
- Guia de estilo com terminais expresso personalizado, fonte
- Crie React App Integration, fonte
Showcase
Projetos reais usando react styleguidist:
- Gráficos de Rumble
- melhor reagt-spinkit
- Componentes semânticos da interface do usuário para reagir
- Componentes de diálogo
- Componentes Bulma
- Componentes yammer
- Mais projetos ...
Integração com outras ferramentas
- Create React App - suportado para fora da caixa, consulte o guia de partida
- Vue, veja Vue Styleguidist
Ferramentas de terceiros
- SnapGuidist: Teste de instantâneo para react styleguidist
- React-estiloguidist-visual: testes visuais automatizados para react styleguidist, usando marionetistas e pixelmatch
- StyleGuidist-Scrapper: Scrapper Script para documentação gerada pelo react styleguidist
Recursos
- O Sonho do Desenvolvimento Divido de Styleguido de Sara Vieira
- Building React Components Library Talk de Robert Haritonov
- Diga queijo: instantâneos e testes visuais
- Entrevista com Artem Sapegin sobre o React Styleguidist.
Alterar log
O log de alterações pode ser encontrado na página de lançamentos.
Contribuindo
Todos são bem -vindos para contribuir. Por favor, reserve um momento para ler as diretrizes contribuintes e o guia do desenvolvedor.
Patrocinando
Torne -se um patrocinador e obtenha seu logotipo em nosso ReadMe no GitHub com um link para o seu site.
Torne -se um patrocinador Obtenha sua imagem em nosso ReadMe no Github com um link para o seu site.
Autores e licença
Artem Sapegin e colaboradores.
Logotipo de Sara Vieira e Andrey Okonetchnikov.
Licença do MIT, consulte o arquivo License.md incluído.
