oxyde/mkdocs.yml at main · mr-fatalyst/oxyde · 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
site_name: Oxyde ORM
site_description: High-performance async Python ORM with Rust core
site_url: https://oxyde.fatalyst.dev/
repo_url: https://github.com/mr-fatalyst/oxyde
repo_name: oxyde-orm/oxyde
docs_dir: docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: light blue
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: light blue
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  logo: img/favicon.png
  favicon: img/favicon.png

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

plugins:
  - search

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - First Project: getting-started/first-project.md
    - FastAPI Project: getting-started/fastapi-project.md
  - Guide:
    - Models: guide/models.md
    - Fields: guide/fields.md
    - Database Connections: guide/connections.md
    - Queries: guide/queries.md
    - Filtering: guide/filtering.md
    - F-Expressions: guide/expressions.md
    - Aggregation: guide/aggregation.md
    - Relations: guide/relations.md
    - Transactions: guide/transactions.md
    - Exceptions: guide/exceptions.md
    - Migrations: guide/migrations.md
  - Advanced:
    - Performance: advanced/performance.md
    - Benchmarks: advanced/benchmarks.md
    - Raw Queries: advanced/raw-queries.md
    - Internals (Rust Core): advanced/internals.md
  - Cheatsheet: cheatsheet.md
  - FAQ: faq.md
  - Changelog: changelog.md

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/mr-fatalyst/oxyde
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/in/nikita-ryzhenkov
    - icon: fontawesome/solid/envelope
      link: mailto:nikita.ryzhenkoff@gmail.com