Skip to content

Configuração ​

O mineproj é configurado via mineproj.config.ts na raiz do seu projeto. O arquivo de configuração exporta um objeto de configuração criado com defineConfig().

Configuração do Site ​

ts
import { defineConfig } from 'mineproj';

export default defineConfig({
  site: {
    title: 'Meu Portfólio',
    description: 'Uma vitrine do meu trabalho',
    url: 'https://example.com',
    defaultLocale: 'en',
    locales: ['en', 'zh-CN'],
    fallbackLocale: 'en',
    prefixAll: false,
    keywords: ['portfolio', 'projects'],
  },
  // ... theme, plugins, api
});

Campos ​

CampoTipoPadrãoDescrição
titlestringobrigatórioTítulo do site
descriptionstring''Descrição do site para meta tags
urlstring''URL de produção (obrigatório para plugins de SEO)
defaultLocalestring'zh-CN'Localidade padrão
localesstring[]['zh-CN']Todas as localidades habilitadas
fallbackLocalestringundefinedFallback para conteúdo não traduzido
prefixAllbooleanfalsePrefixar URLs da localidade padrão também
keywordsstring[][]Palavras-chave de SEO

Configuração do Tema ​

ts
export default defineConfig({
  theme: 'classic',            // atalho, ou nome do pacote, ou caminho local
  themeConfig: {               // passado para o configSchema do tema
    accent: '#2563EB',
    palette: 'neutral',
    colorMode: 'system',
    density: 'comfortable',
    contentWidth: 1280,
    cardStyle: 'grid',
    heroMode: 'hero',
    radius: 'md',
  },
});

Configuração de Plugins ​

ts
export default defineConfig({
  plugins: [
    '@mineproj/plugin-seo',    // atalho
    ['@mineproj/plugin-sitemap', { siteUrl: 'https://example.com' }], // com opções
    {                          // plugin inline
      name: 'meu-plugin',
      hooks: { 'render:before': async (html) => html },
    },
    'vite-plugin-pwa',         // passagem direta de plugin Vite
  ],
});

Estratégia de API ​

ts
export default defineConfig({
  api: {
    strategy: 'hybrid',     // 'client' | 'hybrid' | 'static'
    pageSize: 20,
    pregeneratedPages: 5,
  },
});

Caminhos ​

ts
export default defineConfig({
  dataDir: 'data',        // padrão: 'data'
  outDir: 'dist',         // padrão: 'dist'
  publicDir: 'public',    // padrão: 'public'
});

Released under the Apache-2.0 License.