wizsolucoes / wiz-doc-stencil

Gerador para criar um mini tutorial de como inicializar o seu componente stenciljs em React, Vue e Angular

WIZ DOCS STENCIL

Esse projeto foi desenvolvido para simplificar e ajudar na instalação do seu web componente com Stenciljs, gerando um mini tutorial de como instalar seu web componente em React, Vue e Angular.

Como usar

1 - Entre nesse Link para adicionar seu componente.

2 - Preencha o formulário

Campo NPM

Adicione o registro do npm do seu componente.

Exemplo:

  @minhaOrganizacao/meu-componente

Campo Tag Component

Nesse campo você pode adicionar o seu componente com os principais parametros, adicione os parametros com os valores estaticos pois cada framework tem uma forma de adicionar valores dinâmicos.

Exemplo:

  <my-component type="success" icon="icon-happy" direction="left">
    Você foi logado com sucesso!
  </my-component>

Clica no botão de gerar.

3 - Código

Pronto, Logo após o click do botão foi adicionado 2 novas sessões, Links gerados e Adicione no seu readme.md

Links gerados

Nessa parte deve conter os links de como instalar em cada framework, você pode abrir para testar sua instalação.

Adicione no seu readme.md

Por último copie o código gerado nessa sessão e adicione no seu README.md do seu componente, ele irar conter os links gerados com o mini tutorial de como instalar o seu componente numa aplicação em react, angular e vue.

Exemplo

Frameworks	Link
Angular	Link
React	Link
Vue	Link
outros