Este projeto utiliza VitePress para criar um site de documentação para o Lira Design System. Ele serve como um guia abrangente para a criação e utilização de componentes frontend dentro da equipe da Vega Checkout.
Para ter uma cópia local em execução, siga estes passos simples.
Certifique-se de ter Node.js e npm (ou yarn/pnpm) instalados na sua máquina.
- Clone o repositório:
git clone git@github.com:Cloudfox-net/vegacheckout-lira.git
- Navegue até o diretório do projeto:
cd vegacheckout-lira - Instale as dependências:
npm install
Para iniciar o servidor de desenvolvimento com hot-reloading:
npm run docs:dev
# ou yarn docs:dev
# ou pnpm docs:devAbra seu navegador e visite http://localhost:5173 (ou a porta indicada no terminal).
Para construir o site estático para produção:
npm run docs:build
# ou yarn docs:build
# ou pnpm docs:buildOs arquivos estáticos gerados estarão na pasta .vitepress/dist.
Uma visão geral das pastas e arquivos principais:
.
├── .vitepress/ # Configuração e tema do VitePress
│ ├── config.ts # Arquivo de configuração principal
│ └── theme/ # Arquivos de tema customizado (se houver)
├── components/ # Documentação e exemplos de componentes
├── foundations/ # Documentação de fundamentos de design (cores, tipografia, etc.)
├── public/ # Arquivos estáticos (logo, favicon, etc.)
├── index.md # Página inicial
├── team.md # Página da equipe
├── package.json # Dependências e scripts do projeto
└── README.md # Este arquivo
A navegação principal inclui:
- Equipe (
/team) - Componentes (
/components/status, com sub-itens como formulários)
A barra lateral (sidebar) organiza a documentação de Componentes e Fundações.
Encontre-nos nas redes sociais:
- GitHub: https://github.com/Cloudfox-net
- LinkedIn: https://www.linkedin.com/company/vegacheckout
- Instagram: https://www.instagram.com/vegacheckout
Feito com 💛 pela equipe da Vega Checkout Copyright © 2022-present Vega Tecnologia em Pagamentos