genrec/mkdocs.yml at main · phonism/genrec · 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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
site_name: GenRec
site_description: A Model Zoo for Generative Recommendation
site_author: Qi Lu
site_url: https://phonism.github.io/genrec/

# Repository information
repo_name: phonism/genrec
repo_url: https://github.com/phonism/genrec

# Configuration
theme:
  name: material
  language: zh
  palette:
    - scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: 切换到深色模式
    - scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: 切换到浅色模式
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.share
    - content.code.annotate
    - content.code.copy
    - toc.follow

# Navigation
nav:
  - 首页: index.md
  - 快速开始: zh/getting-started.md
  - 安装指南: zh/installation.md
  - 模型:
    - SASRec: zh/models/sasrec.md
    - HSTU: zh/models/hstu.md
    - RQVAE: zh/models/rqvae.md
    - TIGER: zh/models/tiger.md
    - LCRec: zh/models/lcrec.md
    - COBRA: zh/models/cobra.md
  - 数据集:
    - 概述: zh/dataset/overview.md
    - P5 Amazon: zh/dataset/p5-amazon.md
    - 自定义数据集: zh/dataset/custom.md
  - 训练:
    - RQVAE 训练: zh/training/rqvae.md
    - TIGER 训练: zh/training/tiger.md
  - API 参考: zh/api/index.md
  - 示例: zh/examples.md
  - 常见问题: zh/faq.md
  - 贡献指南: zh/contributing.md

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: phonism
      repo: genrec
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Plugins
plugins:
  - search:
      lang:
        - zh
        - en
  - mkdocstrings
  - i18n:
      docs_structure: folder
      fallback_to_default: true
      languages:
        - locale: zh
          name: 中文
          default: true
          build: true
        - locale: en
          name: English
          build: true
          nav_translations:
            首页: Home
            快速开始: Getting Started
            安装指南: Installation
            模型: Models
            数据集: Dataset
            概述: Overview
            自定义数据集: Custom Datasets
            训练: Training
            RQVAE 训练: RQVAE Training
            TIGER 训练: TIGER Training
            API 参考: API Reference
            示例: Examples
            常见问题: FAQ
            贡献指南: Contributing

# Extra
extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/phonism/genrec
  alternate:
    - name: 中文
      link: /zh/
      lang: zh
    - name: English
      link: /en/
      lang: en

# Extra JavaScript
extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# Extra CSS
extra_css:
  - stylesheets/extra.css