mkdocs.yml

site_name: DISP
theme:
  name: material
  icon:
    repo:  fontawesome/brands/github
  palette:
    primary: purple

nav:
  - Home: "index.md"
  - Getting Started:
    - Installation: "Getting Started/installation.md"
    - Setup for remote computers: "Getting Started/remote_computer.md"
  - Tutorial:
    - Lennard-Jones Solid: "examples/1.1/README.md"
    - Lennard-Jones 38 Cluster: "examples/1.04/README.md"
    - SrTiO3 Ground State: "examples/sto/README.md"
  - Background:
    - Crystal Structure Prediction: "background/structure_searching.md"
    - AIRSS: "background/airss.md"
    - Workflow Engine: "background/workflow_engine.md"
  - "How-To":
    - "Manage Searches": "How-To/manage_search.md"
    - "Analyse Data": "How-To/analyse_data.md"

  - AIRSS Guide:
    - Introduction: "AIRSS Guide/introduction.md"
    - Inputs: "AIRSS Guide/inputs.md"
    - castep_relax: "AIRSS Guide/castep_relax.md"
  - FAQ: "FAQ.md"

markdown_extensions:
  - attr_list
  - footnotes
  - pymdownx.arithmatex:
      generic: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

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

repo_url: https://github.com/zhubonan/disp