docs/mkdocs.yml


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
115
116
117

site_name: Psi Docs (Draft)
repo_url: https://github.com/HydroRoll-Team/psi
repo_name: HydroRoll-Team/psi
edit_uri: edit/main/docs/


theme:
  name: material
  language: en
  icon:
    logo: material/library-outline
    repo: fontawesome/brands/git-alt 
  custom_dir: overrides
  features:
    - content.action.edit
    - content.action.view
    - navigation.footer
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes 
    - toc.follow
    - navigation.top
    - search.highlight
    - search.suggest
    - search.share
    - header.autohide
    - navigation.footer
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default 
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  
extra:
  version:
    provider: mike
    default: stable 
  homepage: https://psi.retrofor.space
  alternate:
    # - name: English
    #   link: /en/ 
    #   lang: en
    - name: 中文
      link: /
      lang: zh
  consent:
    title: Cookie consent
    description: >- 
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
    actions:
      - accept
      - manage
    cookies:
        analytics: 
          name: Google Analytics
          checked: true
        github: 
          name: GitHub
          checked: true
  analytics: 
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >- 
            Thanks for your feedback! Help us improve this page by
            using our <a href="..." target="_blank" rel="noopener">feedback form</a>.
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/HydroRoll-Team
  
extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js

copyright: >
  Copyright &copy; 2013 - PRESENT. <a href="https://github.com/HydroRoll-Team">HydroRoll-Team</a> –
  <a href="#__consent">Change cookie settings</a>

plugins:
  - blog
  - search
  - git-authors
  # - git-revision-date-localized
  # - git-committers:
  #     repository: HydroRoll-Team/psi
  #     branch: main