mkdocs.yml

site_name: zotregistry.dev
site_url: https://zotregistry.dev
site_description: Zot Registry
repo_url: https://github.com/project-zot/zot
repo_name: project-zot/zot
edit_uri: ""
copyright: Copyright &copy; 2019 - 2024 The zot project authors, All Rights Reserved. | The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage</a>
theme:
  name: material
  custom_dir: material
  palette:
    scheme: slate
    primary: black
    accent: teal
  favicon: assets/images/favicon.png
  logo: assets/images/logo.svg
  features:
    - content.code.annotate
    - content.tooltips
    - navigation.instant
    - navigation.tracking
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - search.share
    - toc.follow
    - announce.dismiss
  icon:
    repo: fontawesome/brands/github
  font:
    text: Roboto
    code: Roboto Mono
extra:
  homepage: https://zotregistry.dev
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/project-zot/zot.git
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/zothub
    - icon: fontawesome/brands/slack
      link: https://cloud-native.slack.com/archives/C03EGRE4QGH
  generator: false
  version:
    provider: mike
    default: latest
plugins:
  - search
  - minify:
      minify_html: true
  - git-revision-date-localized
  - macros
  - with-pdf:
      copyright: Copyright &copy; 2019 - 2024 The zot project authors, All Rights Reserved.
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

nav:
  - Home: index.md
  - What's New: general/whats-new.md
  - General: 
    - Concepts: general/concepts.md
    - Key Features: general/features.md
    - Architecture: general/architecture.md
    - Extensions: general/extensions.md
    - Released Images: general/releases.md
    - Glossary: general/glossary.md
    - About: general/project.md
  - User Guides:
    - Push and Pull Image Content: user-guides/user-guide-datapath.md
    - Use the Web Interface to Find Images: user-guides/user-guide-gui.md
    - Command Line (zli): user-guides/zli.md
  - Installation Guides:
    - Installing zot on Bare Metal Linux: install-guides/install-guide-linux.md
    - Installing zot with Kubernetes and Helm: install-guides/install-guide-k8s.md
  - Administrator Guides: 
    - Getting Started: admin-guide/admin-getting-started.md
    - Configuring zot: admin-guide/admin-configuration.md
  - Developer Guide: 
    - Onboarding: developer-guide/onboarding.md
    - Extensions: developer-guide/extensions-dev.md
    - Using the API: developer-guide/api-user-guide.md
    - API Reference: developer-guide/api-reference.md
    - Contributing: developer-guide/contributing.md
  - Articles:
    - CI/CD Pipeline: articles/building-ci-cd-pipeline.md
    - Authentication and Authorization: articles/authn-authz.md
    - Verifying Image Signatures: articles/verifying-signatures.md
    - Immutable Tags: articles/immutable-tags.md
    - Software Provenance Workflow Using OCI Artifacts: articles/workflow.md
    - Security Posture: articles/security-posture.md
    - Storage Planning: articles/storage.md
    - Retention Policies: articles/retention.md
    - Mirroring: articles/mirroring.md
    - Clustering: articles/clustering.md
    - Scale-out clustering: articles/scaleout.md
    - Deploying a Highly Available Registry: articles/high-availability.md
    - Monitoring: articles/monitoring.md
    - Using GraphQL for Enhanced Searches: articles/graphql.md
    - Benchmarking with zb: articles/benchmarking-with-zb.md
    - Performance Profiling: articles/pprofiling.md
    - Using kind for Deployment Testing: articles/kind-deploy.md
extra_css:
  - stylesheets/custom.css