2.3.3.7.3. Readme Files

  • Relative Filepath[1]: ui/readme.yaml

  • Pre-configured: True

[1]: Filepath is relative to the root of the control center directory.

$schema: https://json-schema.org/draft/2020-12/schema
title: README Files Settings
description: Configurations for README files.
type: object
default: { }
additionalProperties: false
properties:
  repo:
    title: Repository README
    description: Main README file of the repository.
    default: { }
    oneOf:
      - type: "null"
      - type: object
        additionalProperties: false
        properties:
          theme:
            type: string
            enum: [ pypackit-default ]
            default: pypackit-default
          config:
            title: Theme Configurations
            description: Configurations for the theme.
            type: object
            default: { }
        required: [ theme, config ]
        allOf:
          - if:
              properties:
                theme:
                  const: pypackit-default
            then:
              properties:
                config:
                  $ref: '#/definitions/theme-pypackit-default'
  package:
    title: Package README
    description: README file of the package used for PyPI/TestPyPI/conda.
    default: { }
    oneOf:
      - type: "null"
      - type: object
        additionalProperties: false
        properties:
          theme:
            type: string
            enum: [ pypackit-default ]
            default: pypackit-default
          config:
            title: Theme Configurations
            description: Configurations for the theme.
            type: object
            default: { }
        required: [ theme, config ]
        allOf:
          - if:
              properties:
                theme:
                  const: pypackit-default
            then:
              properties:
                config:
                  $ref: '#/definitions/theme-pypackit-default'
  dir:
    title: Directory READMEs
    description: Directory README files.
    type: object
    default: { }
    additionalProperties:
      type: string
required: [ repo, package, dir ]

definitions:
  theme-pypackit-default:
    additionalProperties: false
    properties:
      header:
        type: object
        default: { }
        additionalProperties: false
        properties:
          style:
            type: string
            enum: [ horizontal, vertical ]
            default: vertical
          logo:
            type: object
            default: { }
            additionalProperties: false
            properties:
              alt_text:
                type: string
                default: "${{ name }}: ${{ tagline }}"
              title:
                type: string
                default: "Welcome to ${{ name }}! Click to visit our website and learn more."
              width:
                type: string
                default: "80%"
              height:
                type: string
                default: "300px"
          menu_top:
            type: object
            default: { }
            additionalProperties: false
            properties:
              height:
                title: Height
                description: Height of the buttons in the top menu.
                type: string
                default: 35px
              num_spaces:
                type: integer
                default: 2
          menu_bottom:
            type: object
            default: { }
            additionalProperties: false
            properties:
              num_spaces:
                type: integer
                default: 2
              buttons:
                type: array
                default: [ ]
                items:
                  type: object
                  additionalProperties: false
                  properties:
                    title:
                      type: string
                    description:
                      type: string
                    path:
                      type: string
                  required: [ title, path ]
            required: [ num_spaces, buttons ]
      body:
        type: object
        default: { }
        additionalProperties: false
        properties:
          sections:
            type: array
            default:
              - type: keynotes
            items:
              type: object
              additionalProperties: false
              properties:
                type:
                  type: string
                  enum: [ keynotes ]
                config:
                  type: object
                  default: { }
              allOf:
                - if:
                    properties:
                      type:
                        const: keynotes
                  then:
                    properties:
                      config:
                        $ref: '#/definitions/theme-pypackit-default_body-section-keynotes_config'
              required: [ type, config ]
  theme-pypackit-default_body-section-keynotes_config:
    additionalProperties: false
    properties:
      title:
        type: string
        default: Key Features

repo: {}
package: {}
dir: {}