forked from adamhmetal/redbeanpython
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
80 lines (74 loc) · 2.12 KB
/
mkdocs.yml
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
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: RedBeanPython
site_url: https://www.redbeanpython.org/
site_description: Zero config ORM for Python.
site_author: Adam Puza
copyright: "Licence: MIT | Copyright © 2024 Adam Puza"
theme:
name: material
custom_dir: docs/overrides
locale: en
favicon: assets/favicon.png
logo: assets/logo.png
highlightjs: true
hljs_languages:
- python
- bash
palette:
# Palette toggle for light mode
- scheme: default
primary: black
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
primary: black
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- content.code.copy
- content.code.select
- content.code.annotate
- navigation.expand
extra_css:
- stylesheets/extra.css
nav:
- Introduction:
- Welcome: index.md
- Installation: install.md
- Connection: connection.md
- Configuration: custom_configuration.md
- Quick Tour: quick_tour.md
- Basics:
- Conventions: conventions.md
- Types: types.md
- Beans (Models): beans.md
- CRUD: crud.md
- Find, count, exists: finding.md
- Fluid and Frozen (Production). Migrations: fluid_frozen.md
- Tools: tools.md
- Advanced:
- Performance: performance.md
- Hybrid mode:
- Act as SQLAlchemy: hybrid_mode.md
- Bulk operations: bulk_operations.md
- Joined load: joined_load.md
- SQLAlchemy equivalents: migration_to_sqlalchemy.md
- Project:
- Compatibility Table: supported_versions.md
- Changelog: changelog.md
- Roadmap: roadmap.md
- About: licence.md
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg