Documentação Técnica
Guia oficial sincronizado com MANUAL.md
PIV Digital — Template de Conteúdo
Este repositório é um scaffold (molde) para criação de novos Manuais de Identidade Visual. Ele segue a arquitetura Core/Content, onde este repositório contém apenas os dados da marca, delegando a lógica de build e deploy para o motor central piv-core.
🚀 Como começar um novo projeto
Instalação: Certifique-se de que o repositório
piv-coreesteja na mesma pasta raiz deste projeto (ex:../piv-core).npm installConfiguração da Marca: Edite o arquivo
brand_config.jsoncom as cores, tipografia, arquétipos e dados da marca.Conteúdo do Manual: Edite o
MANUAL.mdpara escrever as diretrizes textuais. O sistema suporta Markdown completo.Assets: Coloque os logotipos e imagens em
src/assets/brand/. Certifique-se de que os nomes dos arquivos coincidam com os referenciados nobrand_config.json.
🛠️ Comandos Disponíveis
Este projeto utiliza o motor centralizado para todas as operações:
| Comando | Descrição |
|---|---|
npm run build |
Processa o EJS/Markdown e gera o site estático em /public |
npm run sync-template |
Puxa atualizações de layout e scripts do piv-core |
npm run deploy |
Faz o upload via FTP para o servidor configurado |
📡 Deploy (Configuração)
Para habilitar o deploy automático, crie um arquivo .env na raiz (ele está ignorado pelo git):
FTP_HOST=ftp.agenciaquadri.com
FTP_USER=seu_usuario
FTP_PASS=sua_senha
FTP_PATH=/slug-do-cliente
🏗️ Arquitetura
Este repositório é propositalmente leve. Toda a lógica de processamento de imagens, minificação de CSS e roteamento de templates reside em piv-core.
Não edite arquivos dentro de src/template/ ou scripts de build localmente, pois eles serão sobrescritos no próximo sync-template. Se precisar de uma melhoria no motor, altere diretamente no piv-core.
Introdução
Este manual descreve a identidade visual de {brandName}.
Logotipo
O logotipo é o elemento central de nossa identidade.
Cores
Nossas cores transmitem os valores da marca.
Tipografia
A escolha tipográfica garante clareza e consistência.