odbc-tutorial/mkdocs.yml at main · contact-red/odbc-tutorial · 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
site_name: ODBC Tutorial

copyright: Copyright &copy; 2026 Redvers Davies
#edit_uri: edit/main/docs/
repo_url: https://github.com/contact-red/odbc-tutorial/
site_url: https://odbc-tutorial.contact.red/
use_directory_urls: false

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets:
      base_path: ['code-samples']
      check_paths: true
      dedent_subsections: true
  - smarty
  - toc:
      permalink: true

plugins:
  - search
  - ezlinks

extra_css:
  - assets/ponylang.css

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  palette:
    scheme: ponylang
    primary: brown
    accent: amber
  features:
    - content.code.copy
    - content.code.select
    - navigation.footer
    - navigation.instant
    - navigation.indexes
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest

  icon:
    repo: fontawesome/brands/github

nav:
  - Home: "index.md"
  - Getting Started:
    - Overview: "start/overview.md"
    - What You Need: "start/needs.md"
    - Installing the Library: "start/install.md"
  - The Basics:
    - Shape of the API: "basics/index.md"
    - Connecting: "basics/connecting.md"
    - Executing Statements: "basics/exec.md"
    - Querying: "basics/querying.md"
    - Reading Rows: "basics/rows.md"
    - SQL Types: "basics/sqltypes.md"
  - Prepared Statements:
    - Overview: "prepared/index.md"
    - Binding Parameters: "prepared/binding.md"
    - Executing: "prepared/executing.md"
    - Reusing Statements: "prepared/reuse.md"
    - Prepare-Time Metadata: "prepared/metadata.md"
  - Transactions:
    - Begin / Commit / Rollback: "transactions/index.md"
    - Transaction Errors: "transactions/errors.md"
  - Errors and Diagnostics:
    - Error Philosophy: "errors/index.md"
    - Reading Diagnostics: "errors/diagnostics.md"
    - Warnings: "errors/warnings.md"
  - Advanced:
    - Zero-Allocation Fetch: "advanced/mutable-row.md"
    - Async with DbSession: "advanced/dbsession.md"
    - Cancellation: "advanced/cancellation.md"
  - Reference:
    - Cheat Sheet: "reference/cheatsheet.md"