mkdocs.yml

site_url: !ENV [SITE_URL,"https://docs.juvix.org/"]
site_name: !ENV [SITE_NAME, "Juvix Docs"]
site_dir: !ENV [SITE_DIR, site]
use_directory_urls: false

site_description: The official documentation for Juvix
site_author: The Juvix Team

repo_name: anoma/juvix
repo_url: https://github.com/anoma/juvix
edit_uri: https://github.com/anoma/juvix-docs/edit/main/docs

copyright: "Juvix is a project by Anoma Foundation and GitHub contributors."

exclude_docs: |
  */**/.juvix-build/

extra_javascript:
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - assets/js/highlight.js
  - assets/js/extra.js

extra_css:
  - assets/css/extra.css
  - assets/css/juvix-highlighting.css

theme:
  language: en
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: juvix-light
      primary: deep orange
      accent: orange
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: juvix-dark
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

  features:
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.footer
    - navigation.indexes
    - navigation.path
    - navigation.prune
    - navigation.tabs
    - navigation.tracking
    - search.highlight
    - search.suggest
    - search.share
    - toc.follow

  custom_dir: "docs/overrides"
  font:
    text: Roboto Flex
    code: JetBrains Mono

  favicon: assets/images/favicon/favicon.ico
  logo: assets/logo-juvix.svg

  icon:
    repo: fontawesome/brands/github
    edit: material/file-edit
    view: material/file-eye
    search: octicons/search-16
    previous: octicons/arrow-left-16
    next: octicons/arrow-right-16

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - tables
  - pymdownx.betterem
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  - pymdownx.highlight:
      use_pygments: true
      auto_title: false
  - pymdownx.keys
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

plugins:
  - search:
      lang: en
      pipeline:
        - stemmer
        - stopWordFilter
        - trimmer
  - tags
  - mkdocstrings
  - juvix
  - blog
  - redirects:
      redirect_maps:
        'index.md': 'README.juvix.md'

nav:
  - ./README.juvix.md

  - How-to guides:
      - How-to guides: ./howto/README.md
      - Installing Juvix: ./howto/installing.md
      - Compiling programs: ./howto/compilation.md
      - Setting up a project: ./howto/project.md
      - Contributing: ./howto/contributing.md
      - Judoc documentation tool: ./howto/judoc.md

  - Tutorials:
      - Tutorials: ./tutorials/README.md
      - Essential Juvix: ./tutorials/essential.juvix.md
      - Functional programming with Juvix: ./tutorials/learn.juvix.md
      - Juvix VSCode extension: ./tutorials/vscode.juvix.md
      - Juvix Emacs mode: ./tutorials/emacs.juvix.md

  - Reference:
      - Language reference:
          - Reference: ./reference/README.md
          - Functions: ./reference/language/functions.juvix.md
          - Builtins: ./reference/language/builtins.juvix.md
          - Data types: ./reference/language/datatypes.juvix.md
          - Records: ./reference/language/records.juvix.md
          - Traits: ./reference/language/traits.juvix.md
          - Modules: ./reference/language/modules.md
          - Local definitions: ./reference/language/lets.juvix.md
          - Control structures: ./reference/language/control.juvix.md
          - Comments: ./reference/language/comments.md
          - Pragmas: ./reference/language/pragmas.juvix.md
          - Axioms: ./reference/language/axioms.juvix.md
          - Syntax extensions:
              - Aliases: ./reference/language/aliases.juvix.md
              - Iterators: ./reference/language/iterators.md
              - Fixities: ./reference/language/fixity.juvix.md
              - Operators: ./reference/language/operators.juvix.md

      - Standard library: ./reference/stdlib.md
      - Example programs: ./reference/examples.md
      - Tooling:
          - Documentation Tool: ./reference/judoc.md
          - Command line interface: ./reference/tooling/CLI.md
          - Doctor: ./reference/tooling/doctor.md
          - Emacs mode: ./reference/tooling/emacs.md
          - Haskell test suite: ./reference/tooling/testing.md
      - Compiler implementation: ./reference/compiler.md

  - Standard library: https://anoma.github.io/juvix-stdlib/index.html
  - Packages and Projects: ./juvix-packages.md
  - Blog:
      - blog/index.md
  - Talks:
      - talks.md

validation:
  nav:
    omitted_files: ignore
    not_found: warn
    absolute_links: ignore
  links:
    not_found: warn
    absolute_links: warn
    unrecognized_links: warn