mkdocs.yml

site_name: Pyneal Docs


# Directory where the raw content (i.e. markdown files) lives
docs_dir: content


# Directory where you want the built site to turn up in
site_dir: docs


# Link the markdown files to a given page name
pages:
    - Introduction: index.md        # Note: first one HAS to be named index.md
    - Getting Started:
        - Installation: installation.md
        - Setup: setup.md
    - Overview:
      - Data Flow: dataflow.md
      - Pyneal Scanner: pynealScanner.md
      - Pyneal: pyneal.md
      - End User: endUser.md
    - Simulations: simulations.md
    - Additional Tools:
        - Creating Masks: createMask.md
        - Customized Analyses: customAnalysis.md
    - Troubleshooting: troubleshooting.md
    - Reference:
        - Glossary: glossary.md
        - Image Orientation: imageOrientation.md


# Specify the path to a custom theme. NOTE: 'name' has to be an already installed theme
theme:
    name: material


extra_css:
  - 'stylesheets/extra.css'


extra:
  social:
     - icon: fontawesome/brands/github-alt
       link: https://github.com/jeffmacinnes/pyneal


markdown_extensions:
  - toc:
      permalink: true