Improved docs

Author: maximebf

.gitignore

@@ -4,4 +4,5 @@ dist
 __pycache__
 .coverage
 poetry.lock
-/site
+/site
+.cache

README.md

@@ -6,7 +6,7 @@
 
 ORMs and developers often end up in a love/hate relationship. The advantages of ORMs (the mapping of objects) can be negated by their compromises (have to learn their pseudo sql syntax, less control over the generated sql, low performance).
 
-sqlorm intends to provide a solution where sql stays front and center and where the behavior of the ORM is what you expect and no more. SQL is seamlessly integrated through functions and model methods using python doc strings.
+Sqlorm intends to provide a solution where SQL stays front and center and where the behavior of the ORM is what you expect and no more. SQL is seamlessly integrated through functions and model methods using Python doc strings.
 
 - Thin layer on top of [DBAPI 2.0](https://peps.python.org/pep-0249/)
 - Use SQL as usual

docs/index.md

@@ -1,5 +1,9 @@
 # Introduction
 
+SQL-focused Python ORM
+
+Sqlorm intends to provide a solution where SQL stays front and center and where the behavior of the ORM is what you expect and no more. SQL is seamlessly integrated through functions and model methods using Python doc strings.
+
 ## Installation
 
     pip install sqlorm-py

mkdocs.yml

@@ -1,5 +1,31 @@
 site_name: sqlorm
-theme: material
+repo_url: https://github.com/hyperflask/sqlorm
+edit_uri: edit/main/docs/
+
+theme:
+  name: material
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      primary: blue grey
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: black
+      toggle:
+        icon: material/weather-night
+        name: Switch to light mode
+  features:
+    - content.action.edit
+    - toc.integrate
+  icon:
+    edit: material/pencil
+
 nav:
   - index.md
   - engine.md
@@ -19,4 +45,7 @@ markdown_extensions:
 
 plugins:
   - search
-  - callouts
+  - callouts
+  - git-committers:
+      repository: hyperflask/sqlorm
+      branch: main

pyproject.toml

@@ -23,6 +23,7 @@ pytest-cov = "^4.1.0"
 ruff = "^0.4.3"
 mkdocs-material = "^9.5.24"
 mkdocs-callouts = "^1.13.2"
+mkdocs-git-committers-plugin-2 = "^2.3.0"
 
 [tool.ruff]
 include = ["sqlorm/**/*.py"]