queryleaf/mkdocs.yml at main · beekeeper-studio/queryleaf · 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: QueryLeaf - SQL for MongoDB
site_description: SQL to MongoDB query translator for NodeJS
site_url: https://www.queryleaf.com/
repo_url: https://github.com/beekeeper-studio/queryleaf
repo_name: beekeeper-studio/queryleaf

theme:
  name: material
  palette:
    primary: green
    accent: light green
  logo: assets/logo-white.svg
  favicon: assets/favicon.ico
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.tracking
    - navigation.sections
    - navigation.indexes
    - navigation.tabs
    - navigation.top
    - content.tabs.link
    - content.code.copy
    - content.code.annotate
  custom_dir: docs/overrides

nav:
  - Home: index.md
  - Library:
    - Getting Started:
      - getting-started/installation.md
      - getting-started/quickstart.md
    - Usage:
      - usage/core-concepts.md
      - usage/mongodb-client.md
      - usage/dummy-client.md
      - usage/examples.md
    - Debugging:
      - debugging/troubleshooting.md
      - debugging/limitations.md
  - CLI:
    - Overview: usage/cli.md
  - Server:
    - Overview: usage/server.md
  - PostgreSQL Server:
    - Overview: usage/postgres-server.md
  - SQL Syntax:
    - sql-syntax/index.md
    - sql-syntax/select.md
    - sql-syntax/insert.md
    - sql-syntax/update.md
    - sql-syntax/delete.md
    - sql-syntax/nested-fields.md
    - sql-syntax/array-access.md
    - sql-syntax/joins.md
    - sql-syntax/group-by.md
  - Blog: blog/index.md
  - Support:
    - License FAQ: support/license-faq.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - footnotes

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/beekeeper-studio/queryleaf
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/beekeeperstudio

plugins:
  - search
  - glightbox
  - minify:
      minify_html: true
  - blog

extra_css:
  - stylesheets/extra.css
  - stylesheets/home.css

copyright: Copyright &copy; 2023-2025