mkdocs.yml

site_name: LinkStack documentation
site_description: Documentation of the open-source Linktree alternative
site_url: 'https://docs.linkstack.org'

repo_url: https://github.com/LinkStackOrg/LinkStack
edit_uri: https://github.com/LinkStackOrg/docs/edit/main/docs
repo_name: LinkStack

theme:
    name: material
    custom_dir: docs/assets/overrides
    favicon: assets/img/logo/logo.svg
    logo: assets/img/logo/logo.svg
    icon:
      repo: fontawesome/brands/github
      edit: material/file-edit-outline
    language: 'en'
    font: false
    features:
      - navigation.top
      - navigation.instant
      #- navigation.tabs
      #- navigation.tabs.sticky
      - navigation.sections
      - navigation.indexes
      - toc.follow
      - search.suggest
      - search.highlight
      - search.share
      - content.code.copy
      - navigation.footer
      - content.action.edit
      - content.action.view

    palette:

    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: light blue
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: light blue
      toggle:
        icon: material/lightbulb
        name: Switch to light mode

markdown_extensions:
  # Code highlighting in ``` ``` blocks
  - codehilite:
      guess_lang: true
  # Table of Contents
  - toc:
      permalink: true
  # block-styled side content
  - admonition
  # linkifies URL and email links without having to wrap them in Markdown syntax. Also, allows shortens repository issue, pull request, and commit links.
  - pymdownx.magiclink
  # Task lists (https://facelessuser.github.io/pymdown-extensions/extensions/tasklist)
  - pymdownx.tasklist:
      custom_checkbox: true
  # Highlight words with ==mark me==
  - pymdownx.mark
  # Adds support for deletion ~~Delete me~~ and subscript text~a\ subscript~
  - pymdownx.tilde
  # This extension is a convenience extension which includes many pymdownx extensions
  # (https://facelessuser.github.io/pymdown-extensions/extensions/extra)
  - pymdownx.extra
  # (https://facelessuser.github.io/pymdown-extensions/extensions/details)
  - pymdownx.details
  # Tabbed provides a syntax to easily add tabbed Markdown content.
  # https://facelessuser.github.io/pymdown-extensions/extensions/tabbed/
  - pymdownx.tabbed:
      alternate_style: true
  # Adds syntax for defining footnotes in Markdown documents (https://python-markdown.github.io/extensions/footnotes)
  - footnotes
  # Adds the ability to define abbreviations
  - abbr
  # Metadata support in pages
  # (https://squidfunk.github.io/mkdocs-material/extensions/metadata)
  - meta
  - attr_list
  - md_in_html
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  

nav:
    - Overview:
        - index.md
        - FAQ: faq.md
    - Getting started:
        - getting-started/index.md
        - Requirements: getting-started/requirements.md
        - Download: getting-started/download.md
  
    - Setup:
    #    - First steps: setup/first-steps.md
    #   - Getting to know the Admin Panel: setup/getting-to-know-the-admin-panel.md
          - Setup: setup/setup.md
          - Docker Setup: docker/setup.md
          - Reverse Proxies: docker/reverse-proxies.md
          - Other webservers: setup/other-webservers.md

    #    - Disable registration: setup/disable-registration.md
    - Configuration:
    #     - configuration/index.md
    #     - Email verification: configuration/email-verification.md
    #     - Internal notifications: configuration/internal-notifications.md
    #     - Home URL: configuration/home-url.md
    #     - App Settings: configuration/app-settings.md
    #     - Debug Settings: configuration/debug-settings.md
    #     - Database Settings: configuration/database-settings.md
    #     - Mail Settings: configuration/mail-settings.md
    #     - Cache Settings: configuration/cache-settings.md
    #     - Miscellaneous Settings: configuration/miscellaneous-settings.md
    #     - Social login: configuration/social-login.md
          - Edit Terms, Privacy and Contact: configuration/edit-terms-privacy-and-contact.md


extra:
  social:
    - icon: fontawesome/solid/earth-europe
      link: https://linkstack.org
      name: Website
    - icon: simple/github
      link: https://github.com/LinkStackOrg
      name: GitHub
    - icon: simple/mastodon
      link: https://mstdn.social/@linkstack
      name: Mastodon
    - icon: fontawesome/brands/discord
      link: https://discord.linkstack.org
      name: Discord
    - icon: fontawesome/solid/heart
      link: https://linkstack.org/donate
      name: Sponsor us

copyright: Copyright © 2022 - 2023 LittleLink Custom | 2023 - present LinkStack 

extra_css:
  - assets/css/style.css

extra_javascript:
  - assets/js/script.js

plugins:
  - search:
      lang:
        - en
  - git-revision-date-localized:
      type: timeago
      timezone: Europe/Berlin
      locale: en
      fallback_to_build_date: false
      enable_creation_date: true
      enabled: true
  - git-authors:
      show_contribution: true
      show_line_count: true
      show_email_address: false
      count_empty_lines: true
      fallback_to_empty: true
      sort_authors_by: contribution
      authorship_threshold_percent: 0
      enabled: true
  - enumerate-headings:
      toc_depth: 6
      exclude:
        - index.md
        - faq.md
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true
      skip_classes:
        - nglb
      auto_caption: true
      caption_position: bottom
  #- print-site