crystal-normal-form/mkdocs.yml at main · mcgalcode/crystal-normal-form · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
site_name: Crystal Normal Form
site_description: A Python implementation of the crystallographic mapping algorithm
repo_url: https://github.com/mcgalcode/crystal-normal-form
repo_name: crystal-normal-form

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - content.code.copy

plugins:
  - search
  - mkdocs-jupyter:
      include_source: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - admonition
  - pymdownx.details

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Quickstart: quickstart.ipynb
  - Core:
    - CNF Overview: cnf_overview.ipynb
    - Lattice Normal Form: lattice_normal_form.ipynb
    - Motif Normal Form: motif_normal_form.ipynb
    - Neighbor Finding: neighbor_finding.ipynb
  - Pathfinding:
    - A* Search: astar.ipynb
    - Waterfilling: waterfilling.ipynb
    - Parameter Search: search.ipynb
    - Path Sampling: sample.ipynb
    - Barrier Refinement: ratchet.ipynb