Appearance
Implantação (subdomínio)
Como publicar esta documentação em um subdomínio dedicado.
Visão geral
Esta documentação é um site estático gerado com VitePress. Não depende de PHP ou MySQL — ideal para subdomínio separado, no estilo docs.talktome.com.br.
Subdomínio sugerido: docs.app.growbusiness.com.br
Requisitos
- Node.js 18+
- npm ou pnpm
Desenvolvimento local
bash
cd docs
npm install
npm run devAbre em http://localhost:5173
Build de produção
bash
cd docs
npm install
npm run buildArquivos gerados em docs/.vitepress/dist/
Preview local do build:
bash
npm run previewOpção 1 — Mesmo servidor (Apache/Nginx)
Nginx
nginx
server {
listen 443 ssl http2;
server_name docs.app.growbusiness.com.br;
root /home/appgrowbusinessc/docs/.vitepress/dist;
index index.html;
location / {
try_files $uri $uri/ /index.html;
}
# SSL — use certbot ou certificado existente
}Apache
apache
<VirtualHost *:443>
ServerName docs.app.growbusiness.com.br
DocumentRoot /home/appgrowbusinessc/docs/.vitepress/dist
<Directory /home/appgrowbusinessc/docs/.vitepress/dist>
Options -Indexes +FollowSymLinks
AllowOverride All
Require all granted
</Directory>
# Fallback SPA
FallbackResource /index.html
</VirtualHost>Deploy via rsync/scp
bash
# No servidor de build ou CI
cd docs && npm ci && npm run build
# Enviar dist para o servidor
rsync -avz --delete .vitepress/dist/ user@servidor:/home/appgrowbusinessc/docs/.vitepress/dist/Opção 2 — Netlify / Vercel
Netlify
- Conecte o repositório
- Base directory:
docs - Build command:
npm run build - Publish directory:
docs/.vitepress/dist - Domínio custom:
docs.app.growbusiness.com.br
Vercel
Mesma configuração — root docs, output .vitepress/dist.
Opção 3 — GitHub Actions (CI)
Exemplo de workflow:
yaml
name: Deploy Docs
on:
push:
branches: [main]
paths: ['docs/**']
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
- run: npm ci && npm run build
working-directory: docs
- name: Deploy via rsync
run: rsync -avz --delete .vitepress/dist/ ${{ secrets.DEPLOY_USER }}@${{ secrets.DEPLOY_HOST }}:/path/to/docs/
working-directory: docsDNS
Crie registro CNAME ou A:
| Tipo | Nome | Valor |
|---|---|---|
| CNAME | docs.app | seu-host.netlify.app (se Netlify) |
| A | docs.app | IP do servidor (se VPS) |
SSL
Use Let's Encrypt (certbot) no servidor ou SSL automático do Netlify/Vercel.
Atualizar conteúdo
- Edite arquivos
.mdemdocs/ - Sidebar:
docs/.vitepress/config.mts - Tema/cores:
docs/.vitepress/theme/custom.css - Rebuild e redeploy
Estrutura de pastas
docs/
├── .vitepress/
│ ├── config.mts # Sidebar, nav, SEO
│ └── theme/
│ ├── index.ts
│ └── custom.css # Cores Grow (ciano)
├── public/ # Logo, favicon
├── docs/ # Páginas "Plataforma"
├── pmo/
├── comercial/
├── aprova-grow/
├── clientes/
├── equipe/
├── comunicacao/
├── configuracoes/
├── faq.md
├── deploy.md
└── index.md # HomeLink no painel PMO
Opcional: adicione link Documentação no menu ou footer apontando para:
https://docs.app.growbusiness.com.brPróximo passo
Volte ao Início rápido ou explore a sidebar.