mkdocs.yml

site_name: 'HBS Grid Documentation'
site_url: 'https://hbs-rcs.github.io/hbsgrid-docs/'
copyright: 'Copyright © President & Fellows of Harvard College.'
repo_url: 'https://github.com/hbs-rcs/hbsgrid-docs'
edit_uri: '/hbs-rcs/hbsgrid-docs/edit/main/docs/'
docs_dir: 'docs'
remote_branch: gh-pages

nav:
  - Start Here: 'index.md'
  - Software & Environments:
      - 📦 Available Software: 'software.md'
      - 🚀 Run Desktop Applications: 'menulaunch.md'
      - 🐚 Use the Command-line: 'commandline.md'
      - 🔙 Use Software Versions: 'environments.md'
  - Data & Storage:
      - 🔄 Copy and Transfer Files: 'syncfiles.md'
      - 💾 Storage & Databases: "storage.md"
      - 👥 Collaborate and Share: 'worksafe.md'
  - Help & Support Requests:
      - Support Channels: 'help.md'
      - Account & Project Requests: 'accountmanagement.md'
      - Troubleshooting: 'trouble.md'
  - Tutorials:
    - Topic list: 'tutorials.md'
    - Parallel processing: 'tutorials/scaling-work.md'
    - Large data in R: 'tutorials/large_data_R.md'
    - Web Scraping in Python: 'tutorials/PythonWebScrape.md'
    - NLP in Python: 'tutorials/nlp_with_python.md'

theme:
  name: material
  logo: imgs/rcs.png
  features:
    - toc.integrate
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - content.action.edit
  custom_dir: overrides
  palette:
    scheme: hbs

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - meta
  - tables
  - toc:
      toc_depth: 2
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - mdx_gh_links:
      user: mkdocs
      repo: mkdocs
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji

extra:
  homepage: https://www.hbs.edu/research-computing-services/
  analytics:
    provider: google
    property: G-3P5QKSCGVL
    anonymize_ip: TRUE
  consent:
    title: Cookie consent
    description: >- 
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
          
plugins:
  - tags:
      tags_file: tutorials.md
  - search