XtalPaint/mkdocs.yml at main · psi-lms/XtalPaint · 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
57
58
59
60
61
62
63
site_name: XtalPaint
site_description: Documentation for XtalPaint
site_author: Timo Reents

theme:
  logo: assets/XtalPaint-logo-horizontal.png
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.code.copy
  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

docs_dir: docs

plugins:
  - search
  - mkdocs-jupyter:
      include_source: True
      execute: False
      include: ["*.ipynb"]
      ignore: ["**/.ipynb_checkpoints/*"]

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - Home: index.md
  - Configuration Guide: configuration.md
  - Examples:
      - Running with AiiDA: examples/running-with-AiiDA.ipynb
      - Running without AiiDA: examples/running-wo-AiiDA.ipynb

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/psi-lms/XtalPaint

extra_css:
  - stylesheets/extra.css