Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
121 lines (116 loc) · 3.78 KB
/
Copy pathmkdocs.yml
File metadata and controls
121 lines (116 loc) · 3.78 KB
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
# MkDocs Material configuration for the Yara ORM documentation site.
# Built and deployed to GitHub Pages by .github/workflows/docs.yml.
site_name: Yara ORM
site_description: >-
Fast async Python ORM with a Rust engine — Tortoise-style models, querysets,
relations and migrations for PostgreSQL, MySQL, MariaDB, SQLite, Oracle and
Microsoft SQL Server. A 2–9× faster, fully-typed alternative to Tortoise ORM
and async SQLAlchemy.
site_author: yara-orm contributors
# Canonical site URL — drives sitemap.xml, canonical <link> tags and social cards.
site_url: https://vsdudakov.github.io/yara-orm/
repo_name: vsdudakov/yara-orm
repo_url: https://github.com/vsdudakov/yara-orm
edit_uri: edit/main/docs/
copyright: Copyright © 2026 yara-orm contributors — MIT License
theme:
name: material
language: en
icon:
repo: fontawesome/brands/github
logo: material/database-arrow-right
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: deep purple
accent: deep purple
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep purple
accent: deep purple
toggle:
icon: material/brightness-4
name: Switch to system preference
features:
- navigation.instant
- navigation.tracking
- navigation.sections
- navigation.top
- navigation.footer
- search.suggest
- search.highlight
- search.share
- content.code.copy
- content.code.annotate
- content.tabs.link
- toc.follow
plugins:
- search
# Generates Open Graph / Twitter social cards per page (needs the
# `[imaging]` extra + system Cairo). Enabled only in CI (the docs workflow
# installs Cairo); skipped locally so `mkdocs serve` works without it.
- social:
enabled: !ENV [CI, false]
markdown_extensions:
- abbr
- 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
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/vsdudakov/yara-orm
- icon: fontawesome/brands/python
link: https://pypi.org/project/yara-orm/
- icon: fontawesome/solid/heart
link: https://github.com/sponsors/vsdudakov
name: Sponsor Yara ORM
generator: false
nav:
- Home: index.md
- Getting started:
- Installation: getting-started/installation.md
- Quick start: getting-started/quickstart.md
- Guides:
- Models & fields: guides/models-and-fields.md
- Custom fields: guides/custom-fields.md
- Querying: guides/querying.md
- Working with JSON: guides/json-fields.md
- Relations: guides/relations.md
- Aggregation & grouping: guides/aggregation.md
- Transactions: guides/transactions.md
- Signals: guides/signals.md
- Testing with factories: guides/testing-factories.md
- Manual SQL: guides/manual-sql.md
- Multiple databases: guides/multiple-databases.md
- Migrations: guides/migrations.md
- Migrating from Tortoise: guides/migrating-from-tortoise.md
- Backends:
- PostgreSQL, MySQL, Oracle, SQL Server & SQLite: backends/index.md
- Performance: performance.md
- Architecture: architecture.md
- API reference: api-reference.md
- Contributing: contributing.md