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

data/_data/base/link_schema.yml

@@ -0,0 +1,153 @@
+title: Link Component Configuration
+description: >-
+  Schema for defining and configuring a single link element. This component is
+  often reused by other components to define buttons or navigation items.
+type: object
+properties:
+  with_link:
+    type: boolean
+    default: true
+    description: >-
+      Enables or disables the rendering of the Link component. Set to `true`
+      (default) to display the link; set to `false` to suppress rendering.
+  with_link_data:
+    type: object
+    default: {}
+    description: >-
+      The configuration object containing all attributes necessary to render and
+      style the link element (`<a>`). Requires `name` parameter. The `link` parameter
+      is optional - if omitted, an anchor link is automatically generated from the name
+      for in-page navigation.
+    properties:
+      name:
+        type: string
+        default: ""
+        description: The visible text or label of the link. This field is required unless `icon` is provided for icon-only links.
+      link:
+        type: string
+        default: ""
+        description: >-
+          The target URL the link points to. This can be a relative path (prefixed by site URL settings), a path using `../` (e.g., `../some-page`),
+          or an absolute URL (e.g., `https://example.com`). If omitted, an
+          anchor link is generated from the `name` parameter by converting to lowercase and replacing spaces with hyphens
+          (e.g., "Back to Top" becomes "#back-to-top"), enabling in-page navigation to section headings.
+        format: uri-reference
+      target:
+        type: string
+        default: ""
+        description: >-
+          The link target behavior. Set to `_blank` to open the link in a new window or tab.
+          When set to `_blank` with external cross-domain links, the component automatically adds
+          `rel="noopener noreferrer"` for security and performance best practices, and an
+          external-link icon (fa-solid fa-external-link) is automatically displayed at the end
+          of the link text (unless a custom icon is explicitly provided).
+        enum:
+          - ""
+          - _blank
+      class:
+        type: string
+        default: ""
+        description: >-
+          One or more CSS classes to apply to the link element. Use this
+          to override default link styling and apply component styles like
+          Bootstrap buttons (e.g., `btn btn-primary btn-lg`).
+      role:
+        type: string
+        default: ""
+        description: >-
+          The ARIA role for the link element (e.g., `button` for styled links
+          that act as buttons). Used primarily for accessibility when the HTML
+          element's semantic meaning is being overridden.
+      aria_label:
+        type: string
+        default: ""
+        description: >-
+          The ARIA label providing a concise, accessible description of the link's purpose, used primarily when the link contains no visible text (e.g., icon-only social media buttons).
+      color:
+        type: string
+        default: primary
+        description: >-
+          The visual color of the link text. Possible values are standard
+          Bootstrap color utility classes (e.g., `primary`, `danger`, `dark`).
+        enum:
+          - primary
+          - secondary
+          - success
+          - info
+          - warning
+          - danger
+          - light
+          - dark
+      icon:
+        type: string
+        default: ""
+        description: >-
+          The Font Awesome icon class (e.g., `fa-solid fa-download`) to display
+          within the link. When a custom icon is provided, it overrides any automatic
+          icon generation. For external cross-domain links with `target="_blank"`,
+          the component automatically adds a `fa-solid fa-external-link` icon
+          if no custom icon is specified.
+      icon_position:
+        type: string
+        default: start
+        description: >-
+          The position of the icon relative to the link text. Choose `start`
+          (default) for the icon before the text, or `end` for the icon
+          after the text.
+        enum:
+          - start
+          - end
+    required:
+      - name
+    additionalProperties: false
+  _notes:
+    type: object
+    description: Metadata and reference information
+    properties:
+      implementation_file:
+        type: string
+        default: "src/HTML/jekyll/_includes/link.html.liquid"
+        description: Location of the component implementation
+      user_documentation:
+        type: string
+        default: "examples/jekyll/layouts/default/components/link.md"
+        description: Location of user-facing documentation
+      anchor_generation:
+        type: string
+        default: "When 'link' parameter is omitted, component generates anchor from 'name'"
+        description: Explanation of anchor link generation behavior
+  _examples:
+    type: array
+    description: Practical configuration examples
+    items:
+      - description: "Basic text link"
+        with_link_data:
+          name: "Documentation"
+          link: "/docs/"
+      - description: "Anchor link for in-page navigation"
+        with_link_data:
+          name: "Back to top"
+      - description: "Button with icon"
+        with_link_data:
+          name: "Download"
+          link: "/files/document.pdf"
+          icon: "fa-solid fa-download"
+          class: "btn btn-primary"
+          role: "button"
+      - description: "Icon-only link with accessibility"
+        with_link_data:
+          icon: "fa-solid fa-search"
+          link: "/search/"
+          aria_label: "Open search"
+      - description: "Link opening in new window (automatic external-link icon)"
+        with_link_data:
+          name: "Visit Example"
+          link: "https://example.com"
+          target: "_blank"
+      - description: "Link opening in new window (custom icon override)"
+        with_link_data:
+          name: "Custom Icon"
+          icon: "fa-solid fa-arrow-up-right-from-square"
+          link: "https://example.com"
+          target: "_blank"
+additionalProperties: false

data/_data/base/locales_schema.yml

@@ -0,0 +1,25 @@
+title: Language Selector Component Configuration
+description: >-
+  Schema for configuring the 'Language Selector' component, which allows users
+  to switch between different localized versions of the content.
+type: object
+properties:
+  with_locales:
+    type: boolean
+    default: false
+    description: >-
+      Enables or disables the Language Selector component. Set to `true` to
+      display the selector and initiate the content localization process. Set
+      to `false` (default) to hide the selector.
+  with_locales_data:
+    type: array
+    default: []
+    description: >-
+      An array of ISO 639-1 or ISO 639-2 language codes (e.g., `["en", "es", "fr"]`).
+      These codes are used to define the list of available languages in the
+      selector and initiate the pipeline that generates localized pages.
+    items:
+      type: string
+      description: A single language code (e.g., `es` for Spanish).
+    minItems: 0 # Explicitly allowing an empty array
+additionalProperties: false

data/_data/base/navbar.yml

@@ -0,0 +1,20 @@
+---
+brand_manifestation: jekyll-theme-centos
+navitems: []
+# navitems:
+#   - name: "Link"
+#     icon: "fa-solid fa-book"
+#     link: "/"
+#     menu: []
+#     visible_on: ["navbar"]
+#   - name: "Menu"
+#     icon: "fa-solid fa-book"
+#     link: ""
+#     menu:
+#       - name: Item 1
+#         link: "/item-1/"
+#       - name: Item 2
+#         link: "/item-2/"
+#       - name: Item 3
+#         link: "/item-3/"
+#     visible_on: ["navbar"]

data/_data/base/navbar_schema.yml

@@ -0,0 +1,121 @@
+title: Navigation Bar Component Configuration
+description: >-
+  Schema for configuring the main Navigation Bar (Navbar) component, which
+  includes branding elements and a list of primary navigation links and menus.
+type: object
+properties:
+  with_navbar:
+    type: boolean
+    default: true
+    description: >-
+      Controls the visibility of the Navigation Bar component. Set to `true`
+      (default) to display the navbar at the top of the page. Set to `false`
+      to hide it entirely.
+  with_navbar_data:
+    type: object
+    default: {}
+    description: >-
+      The page-level configuration object for the Navigation Bar component.
+      Settings defined here (in the page's front matter) override any global
+      `navbar` data defined in site-wide `_data` files.
+    properties:
+      class:
+        type: string
+        default: ""
+        description: >-
+          One or more Bootstrap CSS classes to apply to the main `<nav>` element
+          for custom styling, background colors, or utility purposes.
+      brand_image:
+        type: string
+        default: "centos-whitelogo.svg"
+        description: >-
+          The filename of the brand logo or image to display. This file is
+          expected to be located in your site's image assets directory.
+      brand_image_class:
+        type: string
+        default: ""
+        description: >-
+          One or more Bootstrap CSS classes to apply directly to the brand
+          image element (`<img>`).
+      brand_image_height:
+        type: string
+        default: "32"
+        description: >-
+          The desired fixed height for the brand image, specified in pixels
+          as a string (e.g., `"32"`).
+      brand_manifestation:
+        type: string
+        default: ""
+        description: >-
+          The text label or name (e.g., project name) that is typically displayed
+          alongside the brand image.
+      brand_manifestation_class:
+        type: string
+        default: ""
+        description: >-
+          One or more Bootstrap CSS classes to apply to the brand manifestation
+          text element.
+      navitems:
+        type: array
+        default: []
+        description: >-
+          A list of objects defining the primary navigation links and dropdown menus.
+          Each object represents a top-level item in the navbar.
+        items:
+          type: object
+          properties:
+            name:
+              type: string
+              description: The visible text label of the link or menu title. This is required.
+            link:
+              type: string
+              default: ""
+              description: >-
+                The target URL for the link. This should be omitted or left
+                as `""` if the item is a dropdown toggle (i.e., it contains a `menu` array).
+              format: uri-reference
+            icon:
+              type: string
+              default: ""
+              description: >-
+                An icon class (e.g., from Font Awesome) to display next to the label.
+            visible_on:
+              type: array
+              default: ["navbar"]
+              description: >-
+                Controls where the item is displayed. Possible values include
+                `"navbar"`, `"footer"` (referring to the shortcuts component),
+                or both (`["navbar", "footer"]`).
+              items:
+                type: string
+                enum:
+                  - navbar
+                  - footer
+            menu:
+              type: array
+              default: []
+              description: >-
+                If this array contains objects, the item renders as a dropdown menu.
+                If it is an empty array (`[]`), the item renders as a simple link.
+              items:
+                type: object
+                description: A single link item within the dropdown menu.
+                properties:
+                  name:
+                    type: string
+                    description: The visible text for the link within the dropdown menu.
+                  link:
+                    type: string
+                    description: The target URL for the link within the dropdown menu.
+                    format: uri-reference
+                required:
+                  - name
+                  - link # Required for all nested links
+                additionalProperties: false
+              required:
+                - name # Required for all top-level links/menus
+            additionalProperties: false
+      required:
+        - navitems # Navigation is critical for the navbar
+      additionalProperties: false
+additionalProperties: false

data/_data/base/navindex_schema.yml

@@ -0,0 +1,67 @@
+title: Dynamic Content List and Format Configuration
+description: >-
+  Schema for the Dynamic Content List component, which iterates over a provided
+  array of data (e.g., child pages, topics, or component lists) and renders
+  them in one of several configurable visual formats.
+type: object
+properties:
+  data:
+    type: array
+    default: []
+    description: >-
+      The list of items to be rendered. Each item in the array is expected to be an
+      object containing properties such as `title`, `url`, `title_lead`, and optionally
+      `name` or a nested `component` object.
+    items:
+      type: object
+      description: Defines the minimum structure for a single item in the list.
+      properties:
+        title:
+          type: string
+          description: The main display title of the item (used as the link text in most formats).
+        url:
+          type: string
+          description: The target URL for the link (using the external Link component).
+          format: uri-reference
+        title_lead:
+          type: string
+          description: A short description or lead paragraph displayed alongside the link in most formats.
+        name:
+          type: string
+          description: The original filename or slug of the page, used when `show_page_filename` is `true`.
+        component:
+          type: object
+          description: Nested object required for the `component_table` format, containing component-specific metadata.
+          properties:
+            name:
+              type: string
+              description: The programmatic name of the component (e.g., `highlight` or `navbar`), used to check its global status (`with_component_name`).
+          required:
+            - name
+          additionalProperties: false
+      required:
+        - title
+        - url
+      additionalProperties: true
+  format:
+    type: string
+    default: "list"
+    description: >-
+      The visual format used to render the list of data items. Only one value can be selected from the following options: `list` (default),
+      `card`, `text`, `table`, or `component_table`.
+    enum:
+      - list
+      - card
+      - text
+      - table
+      - component_table
+  show_page_filename:
+    type: boolean
+    default: false
+    description: >-
+      When `true`, the list item's display name is derived from the item's filename
+      (`item.name`) instead of the page title (`item.title`). This is primarily
+      used when generating lists of raw files or slugs.
+required:
+  - data
+additionalProperties: false

data/_data/base/ogp_schema.yml

@@ -0,0 +1,186 @@
+title: Open Graph Protocol (OGP) and Twitter Card Configuration
+description: >-
+  Schema for configuring site metadata using the Open Graph Protocol (OGP)
+  and Twitter Cards, enabling rich previews when pages are shared on social
+  media platforms.
+type: object
+properties:
+  with_ogp:
+    type: boolean
+    default: true
+    description: >-
+      Enables or disables the rendering of OGP and Twitter Card `<meta>`
+      tags in the HTML document's `<head>`. Set to `true` (default) to include tags.
+  with_ogp_data:
+    type: object
+    description: Configuration object for OGP (`og:`) and Twitter (`twitter:`) properties.
+    properties:
+      og:
+        type: object
+        description: Configuration for Open Graph (og:) metadata.
+        properties:
+          type:
+            type: string
+            default: website
+            description: Defines the content type via the `og:type` tag (e.g., `website`, `article`, `product`).
+          title:
+            type: string
+            default: The CentOS Project
+            description: The title of the content via the `og:title` tag.
+          description:
+            type: string
+            default: ""
+            description: A short description of the content via the `og:description` tag.
+          image:
+            type: object
+            description: Configuration for the main image used in social media previews (`og:image`).
+            properties:
+              url:
+                type: string
+                format: uri
+                default: "{{ site.url }}{{ site.baseurl }}/assets/img/centos-social-share.png"
+                description: The non-secure URL via the `og:image:url` tag.
+              secure_url:
+                type: string
+                format: uri
+                default: "{{ site.url }}{{ site.baseurl }}/assets/img/centos-social-share.png"
+                description: The secure HTTPS URL via the `og:image:secure_url` tag.
+              type:
+                type: string
+                default: image/png
+                description: The MIME type of the image via the `og:image:type` tag (e.g., `image/jpeg`).
+              width:
+                type: integer
+                default: 1200
+                description: The width of the image in pixels via the `og:image:width` tag.
+              height:
+                type: integer
+                default: 630
+                description: The height of the image in pixels via the `og:image:height` tag.
+              alt:
+                type: string
+                default: "centos-social-share.png"
+                description: A description of the image for accessibility via the `og:image:alt` tag.
+            required:
+              - url
+              - width
+              - height
+            additionalProperties: false
+          audio:
+            type: object
+            description: Configuration for media files to accompany the content (`og:audio`).
+            properties:
+              url:
+                type: string
+                format: uri
+                default: "{{ site.url }}{{ site.baseurl }}/assets/img/centos-social-share.ogg"
+                description: The non-secure URL via the `og:audio:url` tag.
+              secure_url:
+                type: string
+                format: uri
+                default: "{{ site.url }}{{ site.baseurl }}/assets/img/centos-social-share.ogg"
+                description: The secure HTTPS URL via the `og:audio:secure_url` tag.
+              type:
+                type: string
+                default: audio/ogg
+                description: The MIME type of the audio file via the `og:audio:type` tag.
+            additionalProperties: false
+          video:
+            type: object
+            description: Configuration for video media files to accompany the content (`og:video`).
+            properties:
+              url:
+                type: string
+                format: uri
+                default: "{{ site.url }}{{ site.baseurl }}/assets/img/centos-social-share.ogg"
+                description: The non-secure URL via the `og:video:url` tag.
+              secure_url:
+                type: string
+                format: uri
+                default: "{{ site.url }}{{ site.baseurl }}/assets/img/centos-social-share.ogg"
+                description: The secure HTTPS URL via the `og:video:secure_url` tag.
+              type:
+                type: string
+                default: video/ogg
+                description: The MIME type of the video file via the `og:video:type` tag.
+              width:
+                type: integer
+                default: 1200
+                description: The width of the video in pixels via the `og:video:width` tag.
+              height:
+                type: integer
+                default: 630
+                description: The height of the video in pixels via the `og:video:height` tag.
+            required:
+              - url
+              - width
+              - height
+            additionalProperties: false
+        additionalProperties: false
+      twitter:
+        type: object
+        description: Configuration for Twitter Card metadata, which takes precedence on Twitter.
+        properties:
+          card:
+            type: string
+            default: summary_large_image
+            description: Defines the Twitter Card type via the `twitter:card` tag (e.g., `summary`, `summary_large_image`).
+          site:
+            type: object
+            description: The Twitter account of the website via the `twitter:site` tag.
+            properties:
+              id:
+                type: string
+                default: "@CentOS"
+                description: The site's Twitter handle (e.g., `@CentOS`).
+            required:
+              - id
+            additionalProperties: false
+          creator:
+            type: object
+            description: The Twitter account of the content creator via the `twitter:creator` tag.
+            properties:
+              id:
+                type: string
+                default: "@CentOS"
+                description: The creator's Twitter handle (e.g., `@CentOS`).
+            required:
+              - id
+            additionalProperties: false
+          image:
+            type: object
+            description: Configuration for the main image used in the Twitter Card (`twitter:image`).
+            properties:
+              url:
+                type: string
+                format: uri
+                default: "{{ site.url }}{{ site.baseurl }}/assets/img/centos-social-share.png"
+                description: The image URL via the `twitter:image:url` tag.
+              secure_url:
+                type: string
+                format: uri
+                default: "{{ site.url }}{{ site.baseurl }}/assets/img/centos-social-share.png"
+                description: The secure HTTPS image URL.
+              type:
+                type: string
+                default: image/png
+                description: The MIME type of the image.
+              width:
+                type: integer
+                default: 1200
+                description: The width of the image in pixels.
+              height:
+                type: integer
+                default: 630
+                description: The height of the image in pixels.
+              alt:
+                type: string
+                default: "centos-social-share.png"
+                description: The image description for accessibility.
+            required:
+              - url
+              - width
+              - height
+            additionalProperties: false
+        additionalProperties: false
+additionalProperties: false

data/_data/base/project.yml

@@ -0,0 +1,37 @@
+---
+# -------------------------------------------------------------------------------
+# Project Symbol
+# -------------------------------------------------------------------------------
+image: centos-symbol.svg
+image_class: "img-fluid mb-5"
+image_style: "height: 132px;"
+
+# -------------------------------------------------------------------------------
+# Project Name
+# -------------------------------------------------------------------------------
+name: CentOS
+description: Community Enterprise Operating System
+
+# -------------------------------------------------------------------------------
+# Project Actions
+# -------------------------------------------------------------------------------
+# Use short verbs to tell users what they can do inside the project (e.g., Know
+# more, Contribute, etc.). Project actions
+actions:
+  - name: Know more
+    icon: fa-solid fa-arrow-right
+    icon_position: end
+    link: "https://www.centos.org/"
+
+# -------------------------------------------------------------------------------
+# Project Resources
+# -------------------------------------------------------------------------------
+# Use nouns to tell users how the project supports its existence (e.g., GitLab,
+# Mailing Lists, IRC, Blog, etc.)
+resources:
+  - name: Blog
+    icon: fa-solid fa-newspaper
+    link: "https://blog.centos.org/"
+  - name: Mailing Lists
+    icon: fa-solid fa-envelope
+    link: "https://lists.centos.org/"