mkdocs.yml

#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

site_name: Apache Celeborn™
repo_name: apache/celeborn
repo_url: https://gitbox.apache.org/repos/asf/celeborn.git

plugins:
  - search
  - macros
  - include-markdown:
      opening_tag: "{!"
      closing_tag: "!}"

theme:
  font: false
  name: material
  custom_dir: docs/overrides
  language: en
  logo: assets/logo/celeborn-1.svg
  favicon: assets/logo/celeborn-2.svg
  features:
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.superfences

extra:
  version: 0.6.0-SNAPSHOT
  stable_version: 0.5.2
  social:
    - icon: fontawesome/brands/github

copyright: >
  <br>
  Copyright © 2022-2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
  <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy<a/><br>
  <br>
  Apache Celeborn™, Apache, and the Apache feather logo are trademarks or registered trademarks of The Apache Software Foundation.<br>
  <br>
  Please visit <a href="https://www.apache.org/">Apache Software Foundation</a> for more details.<br>
  <br>

nav:
  - Home: index.md
  - Download: download.md
  - Documentation: https://celeborn.apache.org/docs/latest/
  - Who's Using: user.md
  - Community:
      - Join the Mailing Lists: community/maillist.md
      - Project Management Committee: community/project_management_committee.md
      - Become a Committer: community/committer.md
      - Become a PMC Member: community/pmc.md
      - Latest News: community/news.md
      - Release Guide: community/release_guide.md
      - Contributor Guide:
          - Docs and Website: community/contributor_guide/docs_and_website.md
  - Security: security.md
  - Apache Software Foundation:
      - Foundation: https://www.apache.org/" target="_blank
      - License: https://www.apache.org/licenses/" target="_blank
      - Events: https://www.apache.org/events/current-event" target="_blank
      - Sponsorship: https://www.apache.org/foundation/sponsorship.html" target="_blank
      - Thanks: https://www.apache.org/foundation/thanks.html" target="_blank
      - Security: https://www.apache.org/security/" target="_blank
      - Privacy: https://privacy.apache.org/policies/privacy-policy-public.html" target="_blank