docs/mkdocs.yml at master · arepstein/docs · 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
site_name: 'Materials Project Documentation'

# Repository
repo_name: 'materialsproject/docs'
repo_url: 'https://github.com/materialsproject/docs'

nav:
    - Home: 'index.md'
    - Foundation: 'foundation.md'
    - Methodology:
        - 'Total energies': 'methodology/total-energies.md'
        - 'Electronic structure': 'methodology/electronic-structure.md'
        - 'Pseudopotentials': 'methodology/pseudopotentials.md'
        - 'GGA+U': 'methodology/gga-plus-u.md'
        - 'Elasticity': 'methodology/elasticity.md'
        - 'Elasticity prediction': 'methodology/elasticity-prediction.md'
        - 'Piezoelectricity': 'methodology/piezoelectricity.md'
        - 'Dielectricity': 'methodology/dielelectricity.md'
        - 'Equations of State': 'methodology/equations-of-state.md'
        - 'Phonons': 'methodology/phonons.md'
    - User Reference - Website:
        - 'Materials Explorer': 'user-guide/materials-explorer.md'
        - 'Molecules Explorer': 'user-guide/molecules-explorer.md'
    - Contribution:
        - 'Newsfeed': 'contrib/spec/newsfeed.md'

theme:
  name: 'material'

# Extensions
markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true