Edit documentation Edit document
SSR/SSG

Chapters Config

The Chapters Config object provides a structure for managing pages, blogs, and landing pages of your website. This configuration enables functionality such as creating pages, displaying blogs, managing comments, and generating news feeds.

Chapters Config Structure

Pages

The Pages section handles the configuration of the website's pages.

Properties:

Property Name Type Description
app_id number The application ID in GudHub that contains the pages.
slug_field_id number Field ID for storing the page's URL slug.
json_field_id number Field ID for the page's JSON structure.
title_field_id number Field ID for the page's title.
heading_field_id number Field ID for the main heading.
description_field_id number Field ID for the page's description.
blog_main_page_item_id number The item ID of the blog's main page.
image_field_id number Field ID for the page's image.

Blog

The Blog section configures the blog's appearance and functionality.

Properties:

Property Name Type Description
app_id number The application ID for the blog.
slug_field_id number Field ID for the article's URL slug.
title_field_id number Field ID for the article's title.
heading_field_id number Field ID for the article's main heading.
description_field_id number Field ID for the article's description.
intro_field_id number Field ID for the article's introductory text.
content_field_id number Field ID for the article's main content.
type_field_id number Field ID for the article's type.
status_field_id number Field ID for the article's status.
categories_list_field_id number Field ID for the list of categories.
article_post_date_field_id number Field ID for the article's publication date.
article_authorRef number Field ID for the article's author reference.
article_ratings_field_id number Field ID for the article's ratings.

Comments Configuration

Properties:

Property Name Type Description
comments_app_id number Application ID for comments.
comments_status_field_id number Field ID for the comment status.
comments_replyToRef_field_id number Field ID for the parent comment reference.
comments_articleRef_field_id number Field ID for the article reference.
comments_date_field_id number Field ID for the comment's date.

Landings

The Landings section manages the configuration for landing pages.

Properties:

Property Name Type Description
app_id number Application ID for landing pages.
slug_field_id number Field ID for the landing page's URL slug.
title_field_id number Field ID for the landing page's title.
description_field_id number Field ID for the landing page's description.
html_template_field_id number Field ID for the landing page's HTML template.
json_field_id number Field ID for the landing page's JSON configuration.
image_field_id number Field ID for the landing page's image.
export const chapters = {
    pages: {
        app_id: number,
        slug_field_id: number,
        json_field_id: number,
        title_field_id: number,
        heading_field_id: number,
        description_field_id: number,
        blog_main_page_item_id: number, // item_id of blog main page (in application Pages, so this page relate to chapter - pages)
        image_field_id: number
    },
    blog: {
        app_id: number,
        slug_field_id: number,
        title_field_id:  number,
        heading_field_id:  number,
        description_field_id:  number,
        intro_field_id:  number,
        content_field_id:  number,
        
        type_field_id:  number,
        status_field_id:  number,
        categories_list_field_id:  number,

        article_post_date_field_id:  number,
        article_authorRef:  number,
        article_ratings_field_id: number,

        comments_app_id:  number,
        comments_status_field_id:  number,
        comments_replyToRef_field_id:  number,
        comments_articleRef_field_id:  number,
        comments_date_field_id:  number,

        api_app_id: number
    },
    landings: {
        app_id: number,
        slug_field_id: number,
        title_field_id: number,
        description_field_id: number,
        html_template_field_id: number,
        json_field_id: number,
        image_field_id: number
    }
};