Skip to content

features.mdx

Latest commit

 

History

History
444 lines (345 loc) · 9.97 KB

features.mdx

File metadata and controls

444 lines (345 loc) · 9.97 KB
i18nReady true
title Características
description Página de referencia para las características de StudioCMSOptions
sidebar
order
3
tableOfContents
minHeadingLevel maxHeadingLevel
2
5

Referencia del esquema de opciones de configuración de la integración de StudioCMS

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {},
});

robotsTXT

robotsTXT Permite al usuario habilitar/deshabilitar y configurar el uso de la integración personalizada de StudioCMS astro-robots-txt

  • Tipo: RobotsConfig | boolean
  • Valor predeterminado: { policy: [ { userAgent: ['*'], allow: ['/'], disallow: ['/dashboard/'] } ] }

Uso

Nota: robotsTXT también se puede establecer en false para deshabilitarlo.

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    robotsTXT: {
      policy: [ 
        { 
          userAgent: ['*'], 
          allow: ['/'], 
          disallow: ['/dashboard/'],
        } 
      ] 
    }
  }
})

injectQuickActionsMenu

injectQuickActionsMenu permite habilitar y deshabilitar el menú de acciones rápidas que permite un acceso fácil a tu panel de control mientras estás conectado en páginas que no sean del panel de control.

  • Tipo: boolean
  • Valor predeterminado: true

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    injectQuickActionsMenu: true
  }
})

sdk

sdk puede ser un booleano o un objeto que contiene la configuración de caché. Si es un booleano, por defecto se establece en true y se transforma en un objeto con la configuración de caché por defecto.

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
import { Duration } from 'effect';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    sdk: {
      cacheConfig: {
          lifetime: Duration.minutes(5),
      },
    }
  }
})

cacheConfig

cacheConfig es un objeto que se utiliza para configurar la caché para el SDK.

  • Tipo: boolean | { lifetime?: Duration | undefined; } | undefined
  • Valor predeterminado: { lifetime: Duration.minutes(5) }

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
import { Duration } from 'effect';
export default defineStudioCMSConfig({
  features: {
    sdk: {
      // POR DEFECTO - Esto utiliza la configuración de caché por defecto.
      cacheConfig: {
          lifetime: Duration.minutes(5),
      }, 
    }
  }
})

dashboardConfig

dashboardConfig permite la personalización de la configuración del Panel de Control

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    dashboardConfig: {}
  }
})

dashboardEnabled

dashboardEnabled permite al usuario habilitar o deshabilitar el Panel de Control de StudioCMS pero aún así proporcionar todas las herramientas y utilidades a aquellos que están personalizando su configuración, al hacerlo se deshabilitará el panel de control y necesitarás gestionar tu contenido a través de tu base de datos.

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    dashboardConfig: {
      dashboardEnabled: true,
    }
  }
})

inject404Route

inject404Route permite al usuario habilitar o deshabilitar la ruta 404 por defecto para el panel de control

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    dashboardConfig: {
      inject404Route: true,
    }
  }
})

faviconURL

faviconURL permite al usuario sobreescribir la URL del favicon por defecto a una URL personalizada

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    dashboardConfig: {
      faviconURL: '/favicon.svg',
    }
  }
})

dashboardRouteOverride

dashboardRouteOverride permite al usuario cambiar la ruta base en la que se sirve el panel de control (por ejemplo, /admin en lugar de /dashboard)

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    dashboardConfig: {
      dashboardRouteOverride: 'dashboard',
    }
  }
})

versionCheck

versionCheck permite al usuario habilitar o deshabilitar la verificación de versión para el panel de control.

Esto verificará la última versión de StudioCMS y notificará al usuario si hay una nueva versión disponible.

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    dashboardConfig: {
      versionCheck: true,
    }
  }
})

security

security Permite la personalización de la configuración de seguridad

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    dashboardConfig: {
      security: {}
    }
  }
})

hideGeneratorTags

hideGeneratorTags Permite habilitar o deshabilitar las etiquetas meta generator en el HTML del Panel de Control

  • Tipo: boolean
  • Valor predeterminado: false
Uso
import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    dashboardConfig: {
      security: {
        hideGeneratorTags: false
      }
    }
  }
})

authConfig

authConfig Permite la personalización de la configuración de autenticación

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    authConfig: {}
  }
})

enabled

Permite habilitar o deshabilitar la configuración de autenticación

  • Tipo: boolean
  • Valor predeterminado: true

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    authConfig: {
      enabled: true
    }
  }
})

providers

Permite habilitar o deshabilitar los proveedores de autenticación

El siguiente proveedor puede configurarse desde aquí: usernameAndPassword.

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    authConfig: {
      providers: {
        usernameAndPassword: true,
        usernameAndPasswordConfig: {
          allowUserRegistration: true
        }
      }
    }
  }
})

developerConfig

developerConfig Permite la personalización de las opciones de desarrollo

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    developerConfig: {}
  }
})

demoMode

Activar el modo de demostración para el sitio. Si se establece en un objeto, el sitio estará en modo de demostración y el usuario podrá iniciar sesión con el nombre de usuario y contraseña proporcionados.

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    developerConfig: {
      demoMode: {
        username: 'foo',
        password: 'bar'
      }
    }
  }
})

preferredImageService

preferredImageService Permite establecer el identificador del Servicio de Imágenes Preferido

Necesita un Servicio de Imágenes para ser instalado como 'cloudinary-js'

  • Tipo: string | undefined
  • Valor predeterminado: undefined

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    preferredImageService: 'cloudinary-js'
  }
})

webVitals

webVitals Permite habilitar o deshabilitar el seguimiento de Web Vitals

  • Tipo: boolean
  • Valor predeterminado: false

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    webVitals: true
  }
})

api

api permite configurar características específicas de la API

  • Tipo: ApiConfig | undefined
  • Valor predeterminado: undefined

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    api: {
      // características específicas de la API aquí
    }
  }
})

api.apiDocs

apiDocs permite habilitar o deshabilitar la ruta de la documentación de la API que proporciona una especificación OpenAPI para la API de StudioCMS

  • Tipo: boolean
  • Valor predeterminado: true

Uso

import { defineStudioCMSConfig } from 'studiocms/config';
// ---cut---
export default defineStudioCMSConfig({
  features: {
    api: {
      apiDocs: true
    }
  }
})