jekyll-theme-centos 0.0.0

data/_data/base/navbar_schema.yml

@@ -0,0 +1,129 @@
+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.
+  navbar_height:
+    type: integer
+    default: 42
+    description: >-
+      Height in pixels of the fixed-top navbar bar. Used by the breakingnews
+      component and the head component to calculate sticky positioning and
+      scroll-margin-top offsets. Must match the rendered height of
+      `nav.navbar.fixed-top`.
+  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.yml

@@ -0,0 +1,24 @@
+---
+locale: en_US
+og:
+  type: website
+  title: true
+  url: true
+  description: true
+  logo: /assets/icons/apple-touch-icon.png
+  image:
+    url: true
+    alt: The CentOS Project
+    type: image/png
+    width: 1200
+    height: 630
+twitter:
+  card: summary_large_image
+  site: "@CentOS"
+  creator: "@CentOS"
+  title: true
+  url: true
+  description: true
+  image:
+    url: true
+    alt: The CentOS Project

data/_data/base/ogp_schema.yml

@@ -0,0 +1,192 @@
+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: "The CentOS Project"
+                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
+          site_name:
+            type: string
+            description: >-
+              The name of the overall website for the `og:site_name` tag (e.g.,
+              `"CentOS"`). Distinct from the page title. Defaults to `site.title`
+              from the Jekyll configuration when not set explicitly.
+          logo:
+            type: string
+            default: "/assets/icons/apple-touch-icon.png"
+            description: >-
+              Path to the organization logo image for the `og:logo` meta tag.
+              Used by Google Knowledge Graph and some OGP validators to identify
+              the site's primary logo. Not part of the official OGP specification;
+              treated as a path relative to `site.url + site.baseurl`.
+          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: string
+            default: "@CentOS"
+            description: The website's Twitter handle via the `twitter:site` tag (e.g., `@CentOS`).
+          creator:
+            type: string
+            default: "@CentOS"
+            description: The content creator's Twitter handle via the `twitter:creator` tag (e.g., `@CentOS`).
+          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: "The CentOS Project"
+                description: The image description for accessibility.
+            required:
+              - url
+              - width
+              - height
+            additionalProperties: false
+        additionalProperties: false
+      locale:
+        type: string
+        default: "en_US"
+        description: >-
+          Locale of the content in language_TERRITORY format (e.g., `en_US`, `es_ES`).
+          Used by the `og:locale` tag. Should match the site's primary language.
+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/"

data/_data/base/project_schema.yml

@@ -0,0 +1,124 @@
+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 text-bg-dark bg-image
+        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 text-center
+        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: "mb-3"
+        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: gap-2 d-md-flex justify-content-lg-center bg-dark p-2 rounded-top
+        description: Custom CSS classes applied to the container wrapping the resource links.
+      resources_btn_class:
+        type: string
+        default: "btn text-start text-nowrap btn-dark"
+        description: ""
+    required:
+      - name
+      - description
+    additionalProperties: false
+additionalProperties: false

data/_data/base/script_schema.yml

@@ -0,0 +1,41 @@
+title: Script Component Configuration
+description: >-
+  Schema for configuring the script component. These properties are set in
+  the page front matter and are read automatically by the component when
+  it is included in the layout before the closing `</body>` tag.
+type: object
+properties:
+  with_fontawesome:
+    type: boolean
+    default: false
+    description: >-
+      When `true`, includes the Font Awesome JavaScript bundle before the
+      closing `</body>` tag to enable icon rendering across the page.
+  with_highlight:
+    type: boolean
+    default: false
+    description: >-
+      When `true`, includes the Highlight.js JavaScript bundle and
+      initializes syntax highlighting for all code blocks on the page.
+  with_datatable:
+    type: boolean
+    default: false
+    description: >-
+      When `true`, includes the DataTables JavaScript bundle to enable
+      interactive sorting, searching, and pagination on tables that use
+      the `dataTable` CSS class.
+  with_backtotop:
+    type: boolean
+    default: false
+    description: >-
+      When `true`, includes the back-to-top button script, which renders
+      a floating button that scrolls the page back to the top when
+      clicked.
+  with_copyvalue:
+    type: boolean
+    default: false
+    description: >-
+      When `true`, includes the copy-value script, which attaches
+      clipboard copy functionality to elements that use the designated
+      copy-value CSS class.
+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