PESMaker/mkdocs.yml at main · Tingliangstu/PESMaker · 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
site_name: PESMaker
site_description: Foundation-potential-assisted workflow for application-oriented MLIP dataset generation.
site_url: https://Tingliangstu.github.io/PESMaker/
repo_url: https://github.com/Tingliangstu/PESMaker
repo_name: Tingliangstu/PESMaker

theme:
  name: material
  features:
    - navigation.sections
    - navigation.expand
    - content.code.copy

nav:
  - Home: index.md
  - Installation: installation.md
  - Quick Start: usage.md
  - Workflow Guide: ACTIVE_LEARNING_WORKFLOW.md
  - Commands:
      - Overview: commands/index.md
      - init: commands/init.md
      - validate: commands/validate.md
      - next: commands/next.md
      - status: commands/status.md
      - generate: commands/generate.md
      - sample-setup: commands/sample-setup.md
      - select: commands/select.md
      - scf-setup: commands/scf-setup.md
      - submit: commands/submit.md
      - collect: commands/collect.md
      - train: commands/train.md
      - train-setup: commands/train-setup.md
      - plot: commands/plot.md
  - Examples:
      - Minimal YAML: examples/minimal-yaml.md
  - Reference:
      - CLI Index: api/cli.md
  - Theory:
      - Structure Perturbation: theory/perturbation.md
      - Farthest Point Sampling: theory/farthest-point-sampling.md
  - Development:
      - Architecture: ARCHITECTURE.md
      - Code Logic: CODE_LOGIC.md
      - Publishing to PyPI: releasing.md
      - Roadmap: ROADMAP.md
      - Project Brief: PROJECT_BRIEF.md

markdown_extensions:
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.superfences
  - pymdownx.highlight
  - toc:
      permalink: true

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