docs/mkdocs.yml at main · pgdogdev/docs · 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
89
90
91
92
93
site_name: PgDog
repo_url: "https://github.com/pgdogdev/pgdog"
repo_name: pgdogdev/pgdog
site_url: "https://docs.pgdog.dev"
site_description: "PgDog - PostgreSQL query router, pooler, load balancer, and sharding proxy."

extra_css:
  - style.css

theme:
  name: material
  logo: /images/logo-64x64.png
  favicon: /images/logo-64x64.png

  icon:
    repo: fontawesome/brands/github
    admonition:
      note: octicons/tag-16
      tip: octicons/squirrel-16
      warning: octicons/alert-16
      danger: octicons/zap-16
      example: octicons/beaker-16

  features:
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.share
    - toc.follow

  font:
    text: Inter
    code: JetBrains Mono

  palette:
    scheme: slate
    primary: indigo
    accent: indigo

docs_dir: docs

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.mark
  - pymdownx.keys
  - footnotes
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - md_in_html
  - attr_list
  - def_list
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true

plugins:
  - search
  - awesome-pages
  - macros
  - redirects:
      redirect_maps:
        'features/healthchecks.md': 'features/load-balancer/healthchecks.md'
        'features/sharding/migrations.md': 'features/sharding/schema_management/migrations.md'
        'features/sharding/primary-keys.md': 'features/sharding/schema_management/primary_keys.md'
        'features/sharding/cross-shard/index.md': 'features/sharding/cross-shard-queries/index.md'

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pgdogdev/pgdog
  generator: false