databasez/mkdocs.yml at main · dymmond/databasez · 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
site_name: Databasez
site_description: Async database support for Python.
site_url: https://databasez.dymmond.com
docs_dir: docs/generated
site_dir: site

theme:
    name: "material"
    custom_dir: docs/overrides
    language: en
    palette:
        - scheme: "default"
          primary: "cyan"
          accent: "amber"
          media: "(prefers-color-scheme: light)"
          toggle:
              icon: "material/lightbulb"
              name: "Switch to dark mode"
        - scheme: "slate"
          media: "(prefers-color-scheme: dark)"
          primary: "cyan"
          accent: "amber"
          toggle:
              icon: "material/lightbulb-outline"
              name: "Switch to light mode"
    favicon: statics/images/favicon.ico
    logo: statics/images/logo-white.png
    features:
        - search.suggest
        - search.highlight
        - content.tabs.link
        - content.code.copy
        - navigation.indexes
        - navigation.path

repo_name: dymmond/databasez
repo_url: https://github.com/dymmond/databasez
edit_uri: ""
plugins:
    - search

nav:
    - Databasez: "index.md"
    - Architecture Overview: "architecture-overview.md"
    - Core Concepts: "core-concepts.md"
    - Database: "database.md"
    - Database URL: "database-url.md"
    - Queries: "queries.md"
    - Connections & Transactions: "connections-and-transactions.md"
    - Integrations: "integrations.md"
    - Extra drivers and overwrites: "extra-drivers-and-overwrites.md"
    - Test Client: "test-client.md"
    - Tests & Migrations: "tests-and-migrations.md"
    - Troubleshooting: "troubleshooting.md"
    - Vendors: "vendors.md"
    - Databasez People: "databasez-people.md"
    - Contributing: "contributing.md"
    - Sponsorship: "sponsorship.md"
    - Release Notes: "release-notes.md"

markdown_extensions:
    - attr_list
    - toc:
          permalink: true
    - admonition
    - pymdownx.superfences:
          custom_fences:
              - name: mermaid
                class: mermaid
                format: !!python/name:pymdownx.superfences.fence_code_format ""
    - pymdownx.tabbed:
          alternate_style: true
    - pymdownx.inlinehilite
    - pymdownx.highlight:
          use_pygments: true
          anchor_linenums: true
          line_spans: __span
          pygments_lang_class: true
    - md_in_html

extra:
    alternate:
        - link: /
          name: English
          lang: en

extra_css:
  - stylesheets/extra.css