surql/mkdocs.yml at main · Oneiriq/surql · 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
site_name: surql
site_url: https://oneiriq.github.io/surql
site_description: Code-first database toolkit for SurrealDB — TypeScript edition
site_author: Oneiriq
repo_url: https://github.com/Oneiriq/surql
repo_name: Oneiriq/surql
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true
  - pymdownx.snippets:
      base_path: ["."]
  - attr_list
  - md_in_html

plugins:
  - search
  - minify:
      minify_html: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - Quick Start: quickstart.md
      - Upgrade Guide: migration.md
  - Guides:
      - Schema Definition: schema.md
      - Migrations: migrations.md
      - Query Builder: queries.md
      - Query UX: query-ux.md
      - Query Hints: query_hints.md
      - Caching: caching.md
      - Streaming: streaming.md
      - Orchestration: orchestration.md
      - Versioning & Rollback: versioning_rollback.md
      - SurrealDB v3 Patterns: v3-patterns.md
  - Reference:
      - API: api/index.md
      - CLI: cli.md
      - Visualization: visualization.md
  - Examples: examples/index.md
  - Changelog: changelog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Oneiriq/surql
    - icon: material/package-variant
      link: https://jsr.io/@oneiriq/surql