documentation/mkdocs-base.yml at main · mat3ra/documentation · 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
repo_name: 'mat3ra/documentation'
repo_url: 'https://github.com/mat3ra/documentation'
edit_uri: 'edit/main/lang/en/docs/'

extra_css:
    - https://cdnjs.cloudflare.com/ajax/libs/material-design-iconic-font/2.2.0/css/material-design-iconic-font.min.css
    - extra/css/general.css
    - extra/css/tables.css
    - extra/css/images.css
    - extra/css/super-fences.css
    - extra/css/properties.css
    - https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.css

extra_javascript:
    - extra/js/giffer.js
    - extra/js/ga.js
    - extra/js/url_parameters.js
    - extra/js/katex.js
    - extra/js/clickable-rows.js
    - extra/js/search-hint.js
    - https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.js
    - https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/contrib/auto-render.min.js
    - 'https://www.googletagmanager.com/gtag/js?id=UA-69270713-5'

copyright: <a target="_blank" href="https://mat3ra.com">Exabyte Inc</a>. All rights reserved. | <a target="_blank" href="https://platform.mat3ra.com">Back to platform</a>

extra:
    version: "2026.5.28"
    preload_javascript:
        - /extra/js/preload_hotjar.js
        - /extra/js/preload.js
    social:
        - icon: fontawesome/brands/github
          link: https://github.com/mat3ra
        - icon: fontawesome/brands/youtube
          link: https://www.youtube.com/c/Mat3ra/videos
        - icon: fontawesome/brands/linkedin
          link: https://www.linkedin.com/company/mat3ra/
        - icon: fontawesome/brands/x-twitter
          link: https://x.com/mat3ra_com
    analytics:
        provider: google
        property: UA-69270713-5
    jupyterlite:
        origin_url: https://jupyterlite.mat3ra.com/retro/notebooks
        origin_url_lab: https://jupyterlite.mat3ra.com/lab/tree
        notebooks_path_root: made

theme:
    name: material
    custom_dir: theme
    palette:
        primary: deep purple
        accent: deep purple
        scheme: mat3ra
    logo: "images/logo/logo-white.png"
    favicon: "images/logo/favicon.svg"
    icon:
        edit: material/pencil
        repo: fontawesome/brands/github
    font:
        text: Roboto
        code: Roboto Mono
    features:
        - announce.dismiss
        - content.action.edit
        - content.code.annotate
        - content.code.copy
        - content.tooltips
        - navigation.footer
        - navigation.top
        - search.highlight
        - search.suggest

markdown_extensions:
    - admonition
    - attr_list
    - def_list
    - footnotes:
        PLACE_MARKER: "///FOOTNOTES GO HERE///"
    - markdown.extensions.def_list
    - md_in_html
    - toc:
        permalink: true
    - pymdownx.arithmatex:
        generic: true
    - pymdownx.betterem
    - pymdownx.details
    - pymdownx.highlight:
        pygments_lang_class: true
        linenums: true
    - pymdownx.snippets
    - pymdownx.striphtml
    - pymdownx.superfences:
        custom_fences:
            - name: mermaid
              class: mermaid
              format: !!python/name:pymdownx.superfences.fence_code_format
    - pymdownx.tabbed:
        alternate_style: true

plugins:
    - git-revision-date-localized:
        type: date
        enable_creation_date: false
    - search
    - tags
    - macros:
        include_dir: "lang/en/docs/includes/"
        render_by_default: true
    - bibtex:
        bib_file: "lang/en/docs/includes/references.bib"
        citation_template: "{{author}} ({{year}})"
        bibliography_template: "{{author}} ({{year}}). {{title}}. {{journal}}. {{volume}}. {{pages}}."