.mkdocs.yml

#
# s3sync-service - Realtime S3 synchronisation tool
# Copyright (c) 2020  Yevgeniy Valeyev
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

site_name: s3sync-service

repo_url: https://github.com/mazay/s3sync-service

google_analytics: ['G-1S751L8XGK', 'docs.s3sync-service.org']

nav:
  - Home: index.md
  - Getting started:
    - Running locally: running-locally.md
    - Running in docker: running-in-docker.md
    - Running on k8s: running-on-k8s.md
    - Helm Charts: helm-charts.md
    - Known issues/limitations: limitations.md
  - Advance details:
    - How it works: how-it-works.md
    - Configuration: configuration.md
    - S3 compatible: s3-compatible.md
    - Authentication: authentication.md
    - k8s integration: k8s-integration.md
    - Prometheus exporter: prometheus-exporter.md
    - HTTP server: http-server.md

docs_dir: docs
site_dir: site

theme:
  name: readthedocs
  titles_only: true
  highlightjs: true
  hljs_languages:
    - yaml
    - bash

# Build PDF
formats:
  - pdf