mkdocs.yml

site_name: "OpenShifting the hard way"
site_url: ""
site_author: "jbezotte@redhat.com"
copyright: ""
site_description: >-
  Documentation for disconnected OpenShift installs. Conatains all required js, css, and html for the site to function offline.
  If you want just the markdown, download the source repository and extract the markdown files in the docs/ directory.
use_directory_urls: false

plugins:
  - offline
  #- privacy # Not all js bundles are needed, offline and search function fine without this
  - search
  - to-pdf: # Plugin for compiling the docs into one PDF document, formatting may be broken a bit compared to the full site
      enabled_if_env: ENABLE_PDF_EXPORT
      cover_subtitle: "Good luck, and have fun!"
      cover_logo: assets/openshift-logo.png
      output_path: standalone.pdf
  - print-site: # Plugin for compiling the docs into one HTML document, formatting may be broken a bit compared to the full site
      enabled: !ENV [ENABLED_PRINT_SITE, false]
      add_to_navigation: false
      print_page_title: ""
      print_page_basename: "print_page"
      # Table of contents
      add_table_of_contents: true
      toc_title: "Table of Contents"
      toc_depth: 5
      # Content-related
      add_full_urls: true
      enumerate_headings: false
      enumerate_figures: true
      add_cover_page: true
      cover_page_template: ""
      path_to_pdf: ""

nav: 
  - Welcome: index.md
  - Getting started: prereqs.md
  - 1. Connected Setup:
    - connected/index.md
    - 1.1 Tools: connected/tools.md
    - 1.2 Creating imagesets: connected/imagesets.md
    - 1.3 Mirror images to disk: connected/mirroring.md
  - 2. Disconnected Setup:
    - disconnected/index.md
    - 2.1 Tools and data: disconnected/data.md
    - 2.2 Mirror images to registry: disconnected/mirroring.md
    - 2.3 DNS Records: disconnected/dns.md
  - 3. Disconnected Cluster Install:
    - install/index.md
    - 3.1 Cluster Configs and ISO building: install/config.md
    - 3.2 Installing the cluster: install/install.md
  - 4. Post Installation:
    - postinstall/index.md
    - 4.1 Apply Cluster Resources: postinstall/resources.md
    - 4.2 NTP Setup: postinstall/ntp.md
    - 4.3 OpenShift Update Service: postinstall/osus.md
  - Optional:
    - Red Hat Mirror Registry: optional/registry.md
    - Core User Password: optional/corepasswd.md
  - Example Configs:
    - install-config.yaml: examples/install-configs.md
    - agent-config.yaml: examples/agent-configs.md
  - About:
    - Release Notes: release-notes.md

theme:
  name: material
  custom_dir: overrides
  font: false
  features:
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    #- navigation.sections # Expand all nav elements into sections
    #- navigation.tabs
    #- navigation.tabs.sticky
    - navigation.top
    - navigation.indexes # disable for single-page toc html generation
    - navigation.footer
    - toc.follow
    - toc.integrate # disable for single-page toc html generation
    #- header.autohide
    - announce.dismiss

  logo: assets/openshift-logo.png
  icon:
    #logo: material/laptop
    annotation: material/plus-circle
  favicon: assets/openshift-logo.png
  palette: 
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

markdown_extensions:
  - pymdownx.highlight:
      pygments_lang_class: true
      anchor_linenums: true
      line_spans: __span
      use_pygments: true
  - attr_list
  - tables
  - md_in_html
  - footnotes
  - admonition
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
    
extra_css:
  - stylesheets/extra.css

extra:
  generator: false
  social:
    - icon: fontawesome/solid/paper-plane
      link: mailto:jbezotte@redhat.com
      name: Email
    - icon: fontawesome/brands/github
      link: https://github.com/yojoshb/disco-docs
      name: Link to GitHub
    - icon: fontawesome/brands/redhat
      link: https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/disconnected_environments/index
      name: Link to Red Hat Docs