mkdocs.yml

# pip install -r docs/requirements.txt
# mkdocs serve

site_name: github-workflows-kt
site_author: Piotr Krzemiński
repo_url: https://github.com/typesafegithub/github-workflows-kt/
edit_uri: https://github.com/typesafegithub/github-workflows-kt/tree/main/docs

theme:
  logo: Logo.svg
  name: material
  features:
    - navigation.expand
  palette:
    - scheme: default
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

markdown_extensions:
  - pymdownx.magiclink
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path:
        - github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/docsnippets
      check_paths: True
      dedent_subsections: True
  - admonition

plugins:
  - search
  - mkdocs-video

nav:
  - Introduction: 'index.md'
  - User guide:
      - Getting started: 'user-guide/getting_started.md'
      - Using actions: 'user-guide/using-actions.md'
      - Type-safe expressions: 'user-guide/type-safe-expressions.md'
      - Job outputs: 'user-guide/job-outputs.md'
      - Migrating to Maven-based bindings: 'user-guide/migrating-to-Maven-based-bindings.md'
      - Compensating library's missing features: 'user-guide/compensating-librarys-missing-features.md'
      - Nightly builds: 'user-guide/nightly-builds.md'
  - Feature coverage: 'feature-coverage.md'
  - FAQ: 'faq.md'
  - API docs: 'https://typesafegithub.github.io/github-workflows-kt/api-docs/'
  - Projects using this library: 'projects-using-this-library.md'