docs: add MkDocs documentation with Material theme and GitHub Pages deploy
Some checks failed
docs / deploy (push) Has been cancelled

This commit is contained in:
2026-08-17 14:22:34 +03:00
parent 1608b00708
commit 8787342476
18 changed files with 1277 additions and 16 deletions

64
mkdocs.yml Normal file
View File

@@ -0,0 +1,64 @@
site_name: MetaORM
site_description: Async repository layer over SQLModel
site_url: https://olegyurchik.github.io/metaorm/
repo_url: https://github.com/OlegYurchik/metaorm
repo_name: OlegYurchik/metaorm
theme:
name: material
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tabs
- navigation.sections
- navigation.expand
- search.suggest
- search.highlight
- content.code.copy
plugins:
- search
- mkdocstrings:
handlers:
python:
paths: [.]
options:
docstring_style: google
show_source: true
show_root_heading: true
show_category_heading: true
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- tables
- toc:
permalink: true
nav:
- Home: index.md
- User Guide:
- Getting Started: guide/getting-started.md
- Tables & DTOs: guide/tables-dto.md
- Repositories: guide/repositories.md
- Filters & Pagination: guide/filters.md
- Transactions: guide/transactions.md
- Multi-Repo Transactions: guide/container.md
- Eager Loading: guide/relationships.md
- API Reference:
- metaorm: api.md
- Examples: examples.md