mkdocs/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: Iceberg C++
site_description: C++ implementation of Apache Iceberg, an open table format for large analytic datasets
site_url: https://cpp.iceberg.apache.org/
repo_url: "https://github.com/apache/iceberg-cpp"
repo_name: "apache/iceberg-cpp"

theme:
  name: material
  logo: assets/iceberg-logo-icon.png
  favicon: assets/iceberg-logo-icon.png
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.instant
    - navigation.sections
    - content.code.copy
    - toc.integrate
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Library Design: library.md
  - FileIO: file-io.md
  - Contributing: contributing.md
  - Releases:
    - Release History: releases.md
    - Release Process: release-process.md
    - Verify a Release Candidate: verify-rc.md
  - API Documentation: api/index.html
  - SQL Catalog: sql-catalog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/apache/iceberg-cpp
    - icon: fontawesome/brands/slack
      link: https://apache-iceberg.slack.com/