jekyll-theme-centos 2.52.0.beta.4 → 2.52.0.beta.5

data/_data/base/project_schema.yml

@@ -0,0 +1,120 @@
+title: Project Presentation Component Configuration
+description: >-
+  Schema for configuring a prominent display component for a project, featuring
+  branding (logo/icon), a summary, calls-to-action, and key resources.
+type: object
+properties:
+  with_project:
+    type: boolean
+    default: false
+    description: >-
+      Enables or disables the rendering of the Project Presentation template.
+      Set to `true` to display the project component; set to `false` (default) to hide it.
+  with_project_data:
+    type: object
+    default: {}
+    description: >-
+      Custom configuration object for the Project Presentation template. If defined
+      at the page level, these settings override component-specific configuration files.
+    properties:
+      class:
+        type: string
+        default: flex-column bg-image text-bg-dark rounded
+        description: >-
+          Custom Bootstrap classes for the main project container, controlling
+          alignment, background, and text colors (e.g., `padding`, `bg-image`).
+      screenshot:
+        type: string
+        default: ""
+        description: >-
+          The relative file path to a large project screenshot or featured image (relative to `assets/img/`). Used for a prominent visual display.
+      screenshot_alt:
+        type: string
+        default: ""
+        description: The alternative text for the project screenshot, used for accessibility.
+      screenshot_class:
+        type: string
+        default: ""
+        description: Custom CSS classes applied directly to the screenshot image element.
+      image:
+        type: string
+        default: ""
+        description: >-
+          The relative file path to the smaller project logo or branding image (relative to `/assets/img/`).
+      image_alt:
+        type: string
+        default: ""
+        description: The alternative text for the project logo image.
+      image_class:
+        type: string
+        default: img-fluid mb-3
+        description: Custom CSS classes applied to the project logo element (e.g., `img-fluid`, sizing utilities).
+      image_style:
+        type: string
+        default: ""
+        description: >-
+          Inline CSS styles applied directly to the logo image element (e.g., `height: 142px;`).
+          Useful for precise sizing when utility classes are insufficient.
+      icon:
+        type: string
+        default: ""
+        description: >-
+          A Font Awesome icon class (e.g., `fa-solid fa-house`) to display
+          as branding instead of an image.
+      icon_class:
+        type: string
+        default: display-3 fw-bold mb-1
+        description: Custom CSS classes applied to the project icon element.
+      name:
+        type: string
+        default: ""
+        description: The visible title or name of the project. This field is typically required.
+      name_class:
+        type: string
+        default: display-3 fw-bold mb-1
+        description: Custom CSS classes applied to the project name text element.
+      description:
+        type: string
+        default: ""
+        description: A detailed summary or description of the project.
+      description_class:
+        type: string
+        default: lead mb-3
+        description: Custom CSS classes applied to the project description text element.
+      actions:
+        type: array
+        default: []
+        description: >-
+          A list of objects defining prominent call-to-action buttons (e.g., Download, View Demo).
+          Each item uses the Link component schema.
+        items:
+          type: object
+          description: Configuration for a single button using the external Link component properties.
+          additionalProperties: true
+      actions_class:
+        type: string
+        default: ""
+        description: Custom CSS classes applied to the container wrapping the action buttons list.
+      actions_btn_class:
+        type: string
+        default: btn text-nowrap m-1 btn-
+        description: Custom CSS classes applied to each individual action button element.
+      resources:
+        type: array
+        default: []
+        description: >-
+          A list of objects defining secondary resource links (e.g., Source Code, Documentation).
+          Each item uses the Link component schema.
+        items:
+          type: object
+          description: Configuration for a single resource link using the external Link component properties.
+          additionalProperties: true
+      resources_class:
+        type: string
+        default: flex-row flex-wrap bg-dark bg-opacity-75 rounded-bottom-4 py-1 px-5
+        description: Custom CSS classes applied to the container wrapping the resource links.
+    required:
+      - name
+      - description
+    additionalProperties: false
+additionalProperties: false

data/_data/base/shortcut_schema.yml

@@ -0,0 +1,74 @@
+title: Footer Shortcut Links Component Configuration
+description: >-
+  Schema for configuring the 'Shortcut' component, typically displayed in the
+  footer to present key navigation links grouped under headings.
+type: object
+properties:
+  with_shortcut:
+    type: boolean
+    default: true
+    description: >-
+      Controls the visibility of the Shortcut component in the page footer.
+      Set to `true` (default) to display the component; set to `false` to hide it.
+      When enabled, the component will load items where `footer` is included in
+      their `visible_on` property, either from global `navitems` or `with_shortcut_data`.
+  with_shortcut_data:
+    type: object
+    default: {}
+    description: >-
+      Provides a custom set of shortcut navigation items that is completely
+      independent of the main Navigation Bar's configuration. When this variable
+      is defined, its `navitems` list is used exclusively for the footer shortcuts.
+    properties:
+      navitems:
+        type: array
+        default: []
+        description: >-
+          A list of objects defining the top-level shortcut sections or columns.
+          Each object acts as a section heading followed by a list of links (defined in `menu`).
+        items:
+          type: object
+          description: Defines a single shortcut section consisting of a heading and its associated links.
+          properties:
+            name:
+              type: string
+              description: The heading text (title) for this section of links in the footer.
+            link:
+              type: string
+              default: ""
+              description: >-
+                The URL link for top-level items is ignored by this component,
+                as these items are treated only as section headers. It should be omitted or left as `""`.
+            icon:
+              type: string
+              default: ""
+              description: >-
+                An icon class (e.g., from Font Awesome) to display alongside the heading.
+            visible_on:
+              type: array
+              default: ["footer"]
+              description: >-
+                Controls where this item is displayed. For the Shortcut component,
+                this array must contain `"footer"` to be rendered. Other values
+                (like `"navbar"`) are ignored in this context.
+              items:
+                type: string
+                enum:
+                  - navbar
+                  - footer
+            menu:
+              type: array
+              default: []
+              description: >-
+                A list of objects defining the individual link items displayed
+                under the section heading. The inner objects follow the
+                Link component schema.
+              items:
+                type: object
+                description: Configuration for a single link using the external Link component properties.
+                additionalProperties: true
+          required:
+            - name
+            - menu # Must have a menu (list of links) to be a functional shortcut section
+          additionalProperties: false
+    additionalProperties: false

data/_data/base/social.yml

@@ -0,0 +1,25 @@
+---
+#
+# site.data.base.social - Provides social networks information.
+#
+- name: YouTube
+  icon: "fab fa-youtube"
+  link: "https://youtube.com/TheCentOSProject"
+- name: Mastodon
+  icon: "fab fa-mastodon"
+  link: "https://fosstodon.org/@centos"
+- name: Facebook
+  icon: "fab fa-facebook-f"
+  link: "https://www.facebook.com/CentOSProject"
+- name: LinkedIn
+  icon: "fab fa-linkedin"
+  link: "https://www.linkedin.com/company/centos-project/"
+- name: x
+  icon: "fab fa-x-twitter"
+  link: "https://x.com/centos"
+- name: Discourse
+  icon: "fab fa-discourse"
+  link: "https://discussion.fedoraproject.org/c/neighbors/centos/"
+- name: Reddit
+  icon: "fab fa-reddit"
+  link: "https://www.reddit.com/r/CentOS/"

data/_data/base/social_schema.yml

@@ -0,0 +1,53 @@
+title: Social media icons component configuration
+description: >-
+  Schema for configuring and defining the list of social media links
+  (icons) to be rendered, typically in the footer or navigation area.
+type: object
+properties:
+  with_social:
+    type: boolean
+    default: false
+    description: >-
+      Enables or disables the rendering of the social media icons component.
+      Set to `true` to display the icons; set to `false` (default) to hide them.
+  with_social_data:
+    type: object
+    default: {}
+    description: Configuration object for the social media component.
+    properties:
+      links:
+        type: array
+        default: []
+        description: A list of objects, where each object defines a single social media link/icon.
+        items:
+          type: object
+          properties:
+            name:
+              type: string
+              description: The name of the social network (e.g., `YouTube`, `LinkedIn`). Used for alt text and labels.
+            icon:
+              type: string
+              description: >-
+                The Font Awesome icon class representing the social network
+                brand (e.g., `fa-brands fa-x-twitter`).
+              required:
+                - icon
+            link:
+              type: string
+              format: uri
+              description: The absolute URL to the project's profile on this social network (e.g., `https://www.youtube.com/`).
+              required:
+                - link
+          required:
+            - name
+            - icon
+            - link
+          additionalProperties: false
+      class:
+        type: string
+        default: ""
+        description: Custom CSS classes applied to the container element wrapping the social media icons list.
+    required:
+      - links
+    additionalProperties: false
+additionalProperties: false

data/_data/base/title_schema.yml

@@ -0,0 +1,49 @@
+---
+title: Semantic page h1 heading component configuration
+description: >-
+  Schema for configuring the single, primary H1 heading of a page. This component
+  is reserved for the highest-level title, with subsequent headings (H2-H6)
+  typically generated automatically by the content renderer (e.g., Jekyll Markdown).
+type: object
+properties:
+  with_title:
+    type: boolean
+    default: true
+    description: >-
+      Enables or disables the rendering of the primary H1 heading block. Set
+      to `true` (default) to display the configured H1; set to `false` to hide it.
+  with_title_data:
+    type: object
+    default: {}
+    description: Configuration object defining the text and presentation of the page's primary H1 heading.
+    properties:
+      class:
+        type: string
+        default: "row my-4"
+        description: >-
+          One or more CSS classes applied to title container element for custom styling,
+          alignment, or spacing.
+      title:
+        type: string
+        default: "`page.title`"
+        description: The main, primary title text to be displayed. This content is always wrapped in the <h1> HTML tag.
+      title_class:
+        type: string
+        default: "h1"
+        description: >-
+          One or more CSS classes applied to the title element for custom
+          styling, alignment, or spacing (e.g., `text-center`, `display-1`).
+      title_lead:
+        type: string
+        default: "`page.title_lead`"
+        description: An optional lead text or introductory paragraph displayed immediately beneath the H1, providing context or summary.
+      title_lead_class:
+        type: string
+        default: "lead"
+        description: >-
+          One or more CSS classes applied to the title_lead element for custom
+          styling, alignment, or spacing.
+    required:
+      - title
+    additionalProperties: false
+additionalProperties: false

data/_data/base/toc_schema.yml

@@ -0,0 +1,100 @@
+title: Table of Contents Component Configuration
+description: >-
+  Schema for configuring the table of contents (TOC) component that automatically
+  generates a navigable list of headings from page content. Uses Highlight.js
+  jekyll-toc library to dynamically create links to headings within the page.
+type: object
+properties:
+  with_toc:
+    type: boolean
+    default: true
+    description: >-
+      Enables or disables the rendering of the table of contents component.
+      Set to `true` (default) to display the TOC; set to `false` to hide it.
+  with_toc_data:
+    type: object
+    default: {}
+    description: >-
+      Configuration object defining the presentation and behavior of the table
+      of contents, including styling and header level filters.
+    properties:
+      class:
+        type: string
+        default: ""
+        description: >-
+          CSS class(es) assigned to the TOC root list element for custom styling.
+          Multiple classes can be specified separated by spaces (e.g., `my-custom-class another-class`).
+      id:
+        type: string
+        default: ""
+        description: >-
+          The HTML ID attribute assigned to the TOC root list element, used for targeting
+          with CSS or JavaScript (e.g., `page-toc`).
+      item_class:
+        type: string
+        default: ""
+        description: >-
+          CSS class(es) applied to each list item in the TOC. Supports the `%level%`
+          placeholder which is replaced with the current heading level (e.g., `my-2.%level%`).
+      anchor_class:
+        type: string
+        default: ""
+        description: >-
+          CSS class(es) applied to each anchor element (link) in the TOC. Used to style
+          the actual clickable links (e.g., `text-decoration-none text-dark`).
+      h_min:
+        type: integer
+        default: 1
+        minimum: 1
+        maximum: 6
+        description: >-
+          The minimum heading level to include in the TOC. Headers smaller than this
+          level (e.g., h1, h2) will be excluded. Valid range: 1-6.
+      h_max:
+        type: integer
+        default: 6
+        minimum: 1
+        maximum: 6
+        description: >-
+          The maximum heading level to include in the TOC. Headers larger than this
+          level will be excluded. Valid range: 1-6.
+      ordered:
+        type: boolean
+        default: false
+        description: >-
+          When set to `true`, the TOC will be rendered as an ordered list (`<ol>`)
+          instead of an unordered list (`<ul>`). Default is `false` (unordered list).
+      submenu_class:
+        type: string
+        default: ""
+        description: >-
+          CSS class(es) applied to each nested list group representing subheadings.
+          Supports the `%level%` placeholder which is replaced with the submenu level
+          (e.g., `submenu.%level%`).
+      base_url:
+        type: string
+        format: uri
+        default: ""
+        description: >-
+          Base URL prepended to TOC links. Use when the TOC is displayed on a different
+          page than the actual content (e.g., `/docs/`).
+      sanitize:
+        type: boolean
+        default: false
+        description: >-
+          When set to `true`, HTML tags within headings will be stripped from the TOC
+          display text. Default is `false` (HTML is preserved).
+      skip_no_ids:
+        type: boolean
+        default: false
+        description: >-
+          When set to `true`, headings without an `id` attribute will be excluded from
+          the TOC. Default is `false` (all headings are included, with or without IDs).
+      flat_toc:
+        type: boolean
+        default: false
+        description: >-
+          When set to `true`, the TOC will be rendered as a single-level flat list
+          instead of a hierarchical nested structure. Default is `false` (hierarchical).
+    additionalProperties: false
+additionalProperties: false