oransim/mkdocs.yml at main · hck11/oransim · 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
site_name: Oransim
site_description: Causal Digital Twin for Marketing at Scale
site_url: https://oranai-ltd.github.io/oransim/docs/
site_author: OranAI Ltd.
repo_url: https://github.com/OranAi-Ltd/oransim
repo_name: OranAi-Ltd/oransim
edit_uri: edit/main/docs/

copyright: Copyright &copy; 2026 OranAI Ltd. — Apache-2.0

theme:
  name: material
  language: en
  features:
    - navigation.instant
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - search.highlight
    - search.share
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Light mode
  font:
    text: EB Garamond
    code: JetBrains Mono
  logo: ../assets/logo.svg
  favicon: ../assets/logo.svg
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/OranAi-Ltd/oransim
    - icon: fontawesome/solid/envelope
      link: mailto:cto@orannai.com
  generator: false

nav:
  - Home: index.md
  - Quickstart: en/quickstart.md
  - Architecture: en/architecture.md
  - Platforms:
    - Matrix: en/platforms/index.md
    - Writing an Adapter: en/platforms/writing-an-adapter.md
    - Writing a DataProvider: en/platforms/writing-a-provider.md
  - Benchmarks: en/benchmarks/README.md
  - Schemas: en/schemas/README.md
  - 中文:
    - 快速开始: zh/quickstart.md

markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.arithmatex:
      generic: true

plugins:
  - search

extra_javascript:
  # Dropped polyfill.io (service was sold in 2024 and started injecting malware
  # into serviced scripts). Modern browsers ship ES6 natively so no replacement
  # is needed for MathJax's runtime requirements.
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js