mkdocs.yml

site_name: Pushkin
theme:
  name: material
  favicon: 'assets/pushkin_bw_no_text.png'
  logo: 'assets/pushkin_bw_no_text.png'
  features:
    - navigation.top
    - navigation.instant
    - navigation.instant.progress
    - navigation.path
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - toc.follow
  language: en
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
      primary: teal
      accent: pink
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate 
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
      primary: teal
      accent: pink
copyright: 'Copyright © 2015-2024 Joshua Hartshorne'
site_description: 'Pushkin provides a customizable, scalable ecosystem for massive online psychological experiments.'
markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
extra:
  version:
    provider: mike
extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js
plugins:
  - search
  - mike:
      version_selector: true
  - open-in-new-tab
  - table-reader
repo_url: https://github.com/pushkin-consortium/pushkin
repo_name: pushkin-consortium/pushkin
nav:
- Home: 'index.md'
- Getting started:
  - Installation: 'getting-started/installation.md'
  - Quickstart tutorial: 'getting-started/quickstart.md'
  - Deploying to AWS: 'getting-started/deploying-to-aws.md'
  - Simple experiment tutorial: 'getting-started/simple-experiment-tutorial.md'
- Site templates:
  - Overview of site templates: 'site-templates/site-templates-overview.md'
  - site-basic: 'site-templates/site-basic.md'
- Experiment templates:
  - Overview of experiment templates: 'exp-templates/exp-templates-overview.md'
  - exp-basic: 'exp-templates/exp-basic.md'
  - exp-lexical-decision: 'exp-templates/exp-lexical-decision.md'
  - exp-grammaticality-judgment: 'exp-templates/exp-grammaticality-judgment.md'
  - exp-self-paced-reading: 'exp-templates/exp-self-paced-reading.md'
- Packages:
  - Overview of packages: 'packages/packages-overview.md'
  - pushkin-cli: 'packages/pushkin-cli.md'
  - pushkin-api: 'packages/pushkin-api.md'
  - pushkin-client: 'packages/pushkin-client.md'
  - pushkin-worker: 'packages/pushkin-worker.md'
- Developers: 
  - Overview of technologies: 'developers/technologies-overview.md'
  - Getting started on development: 'developers/getting-started-on-development.md'
  - Documentation: 'developers/documentation.md'
  - Contributions: 'developers/contributions.md'
  - Testing: 'developers/testing.md'
  - Security: 'developers/security.md'
- Support:
  - Troubleshooting: 'support/troubleshooting.md'
  - GitHub Discussions: 'support/github-discussions.md'
- About:
  - About Pushkin: 'about/about-pushkin.md'
  - License: 'about/pushkin-license.md'