mkdocs.yml

---
# Project information
site_name: Development Setup
site_url: https://fedejaure.github.io/dev-setup/
site_author: Federico Jaureguialzo
site_description: >-
  My own Ansible collection for development setup.

# Repository
repo_name: fedejaure/dev-setup
repo_url: https://github.com/fedejaure/dev-setup

# Copyright
copyright: "Copyright &copy; 2020 - <script>document.write(new Date().getFullYear())</script> Federico Jaureguialzo"

# Configuration
theme:
  name: material
  custom_dir: material/overrides
  features:
    - announce.dismiss
    # - content.action.edit
    # - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.code.select
    # - content.footnote.tooltips
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: brown
      accent: brown
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: brown
      accent: black
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono
  logo: assets/favicon.png
  favicon: assets/favicon.png
  icon:
    repo: fontawesome/brands/github-alt
    logo: logo

# Plugins
plugins:
  - search:
  - minify:
      minify_html: true
  - termynal:
      prompt_literal_start:
        - "$"
        - "(.venv)$"
        - "(dev-setup)$"

# Hooks
hooks:
  - material/overrides/hooks/fix_markdown_links.py

# Additional configuration
extra:
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
  feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our <a href="https://github.com/fedejaure/dev-setup/issues/new?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">filing an issue</a>.
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/fedejaure

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.mark
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
  - Home: index.md
  - Getting started:
    - Overview: overview.md
    - Usage: usage.md
    - Contributing: contributing.md
    - Code of Conduct: code_of_conduct.md
    - Changelog: changelog.md
    - License: license.md
  - Features:
    - features/index.md
    - MacOS:
      - features/macos/index.md
      - Mac App Store: features/macos/mas.md
      - Homebrew Cask: features/macos/homebrew_cask.md
      - Homebrew Packages: features/macos/homebrew_packages.md
      - Pipx: features/macos/pipx.md
      - Other Tools: features/macos/other_tools.md
    - Linux:
      - features/linux/index.md
  - Configuration:
    - MacOS:
      - configuration/index.md
    - Roles:
      - Third-party Roles: configuration/third_party_roles.md
      - First-party Roles:
        - configuration/first_party_roles/index.md
        - configuration/first_party_roles/oh_my_zsh.md
        - configuration/first_party_roles/pyenv.md