TrueMapData/mkdocs.yml at main · ETSim/TrueMapData · 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
site_name: TMD Library
site_url: https://etstribology.github.io/TrueMapData/
site_description: TrueMap Data (TMD) file processing library
site_author: Antoine Gagnon
repo_url: https://github.com/ETSTribology/TrueMapData
repo_name: ETSTribology/TrueMapData
edit_uri: edit/main/docs/

nav:
  - Home: index.md
  - User guide:
      - Installation: user-guide/installation.md
      - Getting started: user-guide/getting-started.md
      - Working with TMD files: user-guide/working-with-tmd-files.md
      - Visualization: user-guide/visualization.md
      - Exporting data: user-guide/exporting-data.md
      - Tribology metrics: user-guide/tribology-metrics.md
      - Sequential wear analysis: user-guide/sequential-wear-analysis.md
  - Reference:
      - CLI: reference/cli.md
  - Developers:
      - Contributing: developers/contributing.md
      - Building the docs: developers/building-docs.md
      - Documentation style: developers/documentation-style.md
      - AI assistants (llms.txt): developers/ai-tooling.md
  - License: https://github.com/ETSTribology/TrueMapData/blob/main/LICENSE

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: blue grey
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: blue grey
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - content.action.edit

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ETSTribology
      name: ETSTribology on GitHub

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - admonition
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true

plugins:
  - search