Archivo config.json del tema Publii

Publii fusiona el archivo de configuración del tema con el predeterminado que se ve a continuación:

{
    "postTemplates": {},
    "tagTemplates": {},
    "authorTemplates": {},
    "menus": {},
    "renderer": {
        "relatedPostsNumber": 5,
        "includeFeaturedInPosts": true,
        "tagsIncludeFeaturedInPosts": true,
        "authorsIncludeFeaturedInPosts": true,
        "featuredPostsNumber": 0,
        "tagsFeaturedPostsNumber": 0,
        "authorsFeaturedPostsNumber": 0,      
        "includeHandlebarsInHelpers": false,
        "create404page": false,
        "nameFor404page": "404.html"
    },
    "supportedFeatures": {
        "authorImages": true,
        "blockEditor": true,
        "errorPage": true,
        "searchPage": true,
        "tagImages": true,
        "tagsList": true,
        "pages": true
    },
    "config": [
        {
            "name": "logo",
            "label": "Website logo",
            "value": "",
            "type": "media",
            "upload": true
        },
        {
            "name": "postsPerPage",
            "label": "Posts per page",
            "value": 5,
            "type": "number"
        },
        {
            "name": "tagsPostsPerPage",
            "label": "Tags posts per page",
            "value": 5,
            "type": "number"
        },
        {
            "name": "authorsPostsPerPage",
            "label": "Authors posts per page",
            "value": 5,
            "type": "number"
        },
        {
            "name": "excerptLength",
            "label": "Excerpt length",
            "value": 30,
            "type": "number"
        }
    ],
    "customConfig": [],
    "postConfig": [],
    "pageConfig": [],
    "files": {
        "ignoreAssets": [
            "scss",
            ".DS_Store"
        ],
        "assetsPath": "assets",
        "partialsPath": "partials",
        "useDynamicAssets": false
    },
    "customElements": []
}

Los campos name, version, authorson OBLIGATORIOS. Los demás campos se fusionarán con el archivo config.json predeterminado si algunos campos no existen en el archivo config.json del tema .

La sección del renderizador

La sección de renderizador contiene valores que no se deben cambiar en las opciones del tema, pero que pueden ser modificados por el desarrollador del tema o por usuarios más avanzados. Para obtener información más detallada sobre la configuración de las opciones del renderizador , consulta el artículo de la documentación de Publii sobre Cómo configurar el proceso de renderizado de tu sitio web .

La sección de características admitidas

La sección supportedFeatures del archivo config.json se utiliza para indicar qué funciones de Publii son compatibles con el tema. Esto permite a los usuarios identificar fácilmente si un tema ofrece la funcionalidad deseada y facilita la elección de un tema que satisfaga sus necesidades.

Para obtener más información sobre la sección Características compatibles y las funciones admitidas, consulta el artículo Características compatibles del tema .

La sección de configuración

La sección de configuración contiene algunas opciones útiles para el usuario y el renderizador de temas:

• postsPerPage - número de publicaciones mostradas en la página de inicio y en la página de etiquetas (si no se ha configurado tags_posts_per_page ),
• tagsPostsPerPage - número de publicaciones mostradas en las páginas de etiquetas,
• excerptLength - longitud de los extractos en palabras.

Para las publicaciones por página, un valor de opción de 0 se define como una cantidad ilimitada (aunque técnicamente no es ilimitada; el máximo es 999 publicaciones por página) de publicaciones mostradas.

La sección de archivos le permite modificar el comportamiento del renderizador:

• ignoreAssets : una matriz que define los recursos (archivos y directorios) que se deben ignorar al copiar activos al directorio de salida.
• assetsPath : especifica qué directorio contiene los activos del tema
• partialsPath : especifica qué directorio contiene los archivos parciales del tema
• useDynamicAssets : especifica si el tema usa activos dinámicos o no.
• responsiveImages : especifica el atributo de tamaño y las dimensiones (y el modo de recorte) de las miniaturas creadas. Si no se define la configuración de featuredImages, todas las imágenes utilizarán la configuración de contentImages. Puede utilizar "auto" en lugar de un número si desea cambiar el tamaño de las imágenes según una dimensión.

¡ADVERTENCIA!  Los nombres de las dimensiones de las imágenes no pueden contener caracteres no latinos, espacios, comas, etc. y siempre deben estar en minúsculas.

La sección de menús opcionales es un objeto con las áreas de menú disponibles.

¡ADVERTENCIA! Las claves de este objeto solo deben utilizar letras, ya que se utilizarán en el menú parcial como parámetro del objeto de menús.

En las secciones opcionales postTemplates/tagTemplates/authorTemplates , puede crear una colección de pares clave-valor que se usarán para generar la lista de plantillas de publicación/etiqueta/autor.

La sección opcional customElements agrega estilos personalizados para elementos específicos que se pueden previsualizar en nuestro editor de publicaciones. Al agregar un customElementscampo, puede usar todos los elementos personalizados que ofrece el editor TinyMCE .

Más ejemplos

Un ejemplo para la sección de menús:

"menus": {
    "mainMenu": "Main menu", 
    "footerMenu": "Footer menu"
},

Un ejemplo para la sección customElements:

"customElements": [
        {
            "label": "Custom style",
            "cssClasses": "custom-style",
            "tag": "span"
        },
        {
            "label": "Custom style 2",
            "cssClasses": "custom-style-2",
            "selector": "p"
        }
]

La etiqueta hace que el elemento quede envuelto por el elemento especificado en la etiqueta, con las clases CSS definidas en  cssClasses  agregadas. Si se configura  el selector , las cssClasses especificadas  se agregarán a los elementos que coincidan con el selector proporcionado (debe usarse especialmente al aplicar estilo a párrafos).

Un ejemplo para la sección de plantillas:

"postTemplates": {
       "alternative": "Post alternative template (from post-alternative.hbs file)"
},
"pageTemplates": {
       "alternative": "Page alternative template (from page-alternative.hbs file)"
},
"tagTemplates": {
       "alternative": "Tag alternative template (from tag-alternative.hbs file)"
},
"authorTemplates": {
       "alternative": "Author alternative template (from author-alternative.hbs file)"
},