cactus/mkdocs.yml at main · cactus-compute/cactus · 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
site_name: Cactus Docs
site_url: https://docs.cactuscompute.com/
site_description: "Low-latency AI engine for mobile devices and wearables"
site_author: Cactus Compute
repo_url: https://github.com/cactus-compute/cactus
repo_name: cactus-compute/cactus

docs_dir: site_docs

theme:
  name: material
  custom_dir: .github/docs-overrides
  logo: assets/logo_white.png
  favicon: assets/logo_white.png
  font: false
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - toc.follow
  palette:
    - scheme: slate
      primary: black
      accent: white
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: black
      accent: black
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - md_in_html
  - toc:
      permalink: true
  - tables
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: [site_docs]

plugins:
  - search

extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/cactus-compute/cactus
    - icon: fontawesome/brands/reddit
      link: https://www.reddit.com/r/cactuscompute/

extra_css:
  - stylesheets/custom.css

nav:
  - Home: index.md
  - Quickstart: docs/quickstart.md
  - Choose Your SDK: docs/choose-sdk.md
  - SDKs:
    - React Native: react-native/README.md
    - Python: python/README.md
    - Swift: apple/README.md
    - Kotlin / Android: android/README.md
    - Flutter: flutter/README.md
    - Rust: rust/README.md
  - Core APIs (C++):
    - Engine API: docs/cactus_engine.md
    - Graph API: docs/cactus_graph.md
    - Index API: docs/cactus_index.md
  - Guides:
    - Fine-tuning & Deployment: docs/finetuning.md
    - Runtime Compatibility: docs/compatibility.md
  - Contributing: CONTRIBUTING.md
  - Blog:
    - All Posts: blog/README.md
    - Hybrid Transcription: blog/hybrid_transcription.md
    - "LFM2-24B on Mac": blog/lfm2_24b_a2b.md
    - "Parakeet CTC 1.1B": blog/parakeet.md
    - "LFM-2.5-350m": blog/lfm2.5_350m.md