rayforce/mkdocs.yml at master · RayforceDB/rayforce · 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
161
162
163
164
165
166
167
168
169
170
171
172
173
site_name: Rayforce
site_description: Rayforce — embeddable columnar analytics and graph traversal engine in pure C17. Built-in Rayfall query language, IPC, datalog, and vector search.
site_url: https://rayforcedb.com/
site_author: Anton Kundenko
copyright: Copyright &copy; 2025-2026 Anton Kundenko · MIT licensed
repo_name: RayforceDB/rayforce
repo_url: https://github.com/RayforceDB/rayforce
edit_uri: edit/master/docs/

docs_dir: docs
site_dir: site
exclude_docs: |
  superpowers/

# about.md is a marketing-style page reachable from the pill nav and
# the marketing footer — intentionally outside the docs sidebar.
not_in_nav: |
  /about.md

theme:
  name: material
  custom_dir: overrides
  language: en
  logo: assets/logo-light-full.svg
  favicon: assets/favicon.svg
  # font: false disables Material's Google Fonts loader.  Our extra.css
  # declares @font-face for the brand fonts (Inter, Oswald, JetBrains Mono)
  # hosted at /assets/fonts/ alongside the marketing site.
  font: false
  palette:
    # Single scheme to match the marketing site — no light/dark toggle.
    scheme: slate
  features:
    # `navigation.instant` intentionally omitted — it client-side-swaps
    # only the content area, which breaks transitions between the docs
    # template (Material chrome) and the landing template (custom hero
    # via overrides/home.html).  Clicking the logo from a docs page
    # would otherwise render the landing inside the docs shell until
    # the user hard-refreshes.
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/RayforceDB/rayforce

extra_css:
  - assets/extra.css

extra_javascript:
  - javascripts/main.js

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.caret
  - pymdownx.smartsymbols
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
# Old website/docs/*.html URLs are preserved via static stubs in docs/*.html
# (each has a meta-refresh to the new directory URL).  See the *.html files
# committed alongside this config; they're copied verbatim into site/ by
# MkDocs, so /docs/quick-start.html, /docs/ipc-hooks.html, etc. keep working.
#
# Disabled: mkdocs-redirects plugin (only accepts .md keys, not .html).

nav:
  - Home: index.md
  - Docs:
      - Overview: docs/index.md
      - Getting Started:
          - Quick Start: docs/getting-started/quick-start.md
          - Tutorial: docs/getting-started/tutorial.md
      - Tutorials:
          - Graph Queries: docs/tutorials/graph.md
          - Datalog: docs/tutorials/datalog.md
          - Data Loading: docs/tutorials/storage.md
          - Advanced Analytics: docs/tutorials/analytics.md
      - Rayfall Language:
          - Syntax: docs/language/syntax.md
          - Functions Reference: docs/language/functions.md
          - Math Operations: docs/language/math.md
          - String Operations: docs/language/string.md
          - Control Flow: docs/language/control-flow.md
          - REPL Reference: docs/language/repl.md
      - Namespaces:
          - Overview: docs/namespaces/index.md
          - .col — Column linking: docs/namespaces/col.md
          - .csv — CSV I/O: docs/namespaces/csv.md
          - .db — Tables on disk: docs/namespaces/db.md
          - .graph — Graph algorithms: docs/namespaces/graph.md
          - .idx — Indexes: docs/namespaces/idx.md
          - .ipc — IPC client: docs/namespaces/ipc.md
          - .log — Write-ahead log: docs/namespaces/log.md
          - .os — Filesystem & env: docs/namespaces/os.md
          - .repl — REPL control: docs/namespaces/repl.md
          - .sys — System info: docs/namespaces/sys.md
          - .time — Clock & timers: docs/namespaces/time.md
      - Data & Types:
          - Data Types: docs/data-types/index.md
          - Collections: docs/data-types/collections.md
      - Queries:
          - Select Queries: docs/queries/select.md
          - Joins: docs/queries/joins.md
          - Linked Columns: docs/queries/links.md
          - Indexes Overview: docs/queries/indexes-overview.md
          - Accelerator Indexes: docs/queries/indexes.md
          - Pivot: docs/queries/pivot.md
      - Storage & IPC:
          - Columnar Storage: docs/storage/index.md
          - IPC & Serialization: docs/storage/ipc.md
          - IPC Connection Hooks: docs/storage/ipc-hooks.md
      - Graph Engine:
          - Graph Storage: docs/graph/storage.md
          - Graph Algorithms: docs/graph/algorithms.md
          - Vector Search: docs/graph/vector-search.md
      - Guides:
          - Indexes Guide: docs/guides/indexes.md
          - Analytics Cookbook: docs/guides/analytics.md
          - Datalog Guide: docs/guides/datalog.md
          - Datalog Reference: docs/guides/datalog-reference.md
          - Storage Guide: docs/guides/storage.md
          - IPC Guide: docs/guides/ipc.md
          - Error Handling: docs/guides/errors.md
          - Memory & Monitoring: docs/guides/memory.md
          - Type Casting: docs/guides/types.md
      - Architecture:
          - Pipeline & Optimizer: docs/architecture/pipeline.md
          - Memory Model: docs/architecture/memory.md
          - Block Offloading: docs/architecture/offloading.md
      - C API:
          - Core API: docs/c-api/core.md
          - DAG API: docs/c-api/dag.md
      - Reference:
          - All Functions: docs/reference/all-functions.md