beekeeper-studio/mkdocs.yml at master · bhatmand-forks/beekeeper-studio · 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
site_name: Beekeeper Studio Documentation
site_url: https://docs.beekeeperstudio.io
site_description: Beekeeper Studio user documentation - how to install, configure, and use Beekeeper Studio
copyright: Copyright &copy; Beekeeper Studio, Inc
repo_url: https://github.com/beekeeper-studio/beekeeper-studio
repo_name: beekeeper-studio
edit_uri: edit/master/docs
extra:
  social:
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/beekeeperdata
      name: Beekeeper on X (Twitter)
    - icon: fontawesome/brands/github
      link: https://github.com/beekeeper-studio/beekeeper-studio
      name: Beekeeper Studio on GitHub
  generator: false
theme:
  logo: assets/bks.svg
  favicon: assets/favicon-96x96.png
  name: material
  icon:
    repo: fontawesome/brands/github
  font:
    text: Rubik
  features:
    - navigation.instant
    # - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    # - navigation.sections
    - navigation.footer
    - navigation.top
    - navigation.tabs
    - search.suggest
    - search.highlight
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.tooltips

  palette:
    scheme: slate
    primary: custom
    accent: custom

extra_css:
  - stylesheets/extra.css
extra_javascript:
  - javascript/extra.js
plugins:
  - search
  - include-markdown
#  - social:
#      cards_layout_options:
#        background_color: "#2c2c2c"
#        color: "#ffffff"
#        font_family: Rubik
  - ini-includer:
      base_path: ../apps/studio
      config_file: default.config.ini
markdown_extensions:
  - pymdownx.tasklist:
      custom_checkbox: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - tables
  - abbr
  - attr_list
  - md_in_html
  - nl2br
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Introduction:
    - index.md
    - getting-started-guide.md
  - Installation:
    - installation/index.md
    - installation/windows.md
    - installation/macos-m1-intel.md
    - installation/linux.md
  - Connecting To A Database:
    - user_guide/connecting/supported-databases.md
    - Connection Options: user_guide/connecting/connecting.md
    - user_guide/connecting/amazon-rds.md
    - ClickHouse: user_guide/connecting/clickhouse.md
    - user_guide/connecting/duckdb.md
    - user_guide/connecting/firebird.md
    - user_guide/connecting/google-bigquery.md
    - user_guide/connecting/mongodb.md
    - user_guide/connecting/oracle-database.md
    - SQLite: user_guide/connecting/sqlite.md
    - Trino: user_guide/connecting/trino.md
    - user_guide/connecting/surrealdb.md

  - Features:
    - user_guide/sql_editor/editor.md
    - user_guide/sql-ai-shell.md
    - user_guide/editing-data.md
    - user_guide/modify-tables.md
    - user_guide/sql_editor/saving_queries.md
    - user_guide/json-sidebar.md
    - user_guide/query-magics.md
    - Data Import: user_guide/importing-data-csv-json-etc.md
    - user_guide/data-export.md
    - Diagrams: user_guide/entity-relationship-diagrams-erd.md
    - user_guide/backup-restore.md
    - Cloud Workspaces: user_guide/cloud-storage-team-workspaces.md
    - user_guide/security.md
    - Plugins: user_guide/plugins.md
    - Configuration: user_guide/configuration.md
  # - Plugin Development:
  #   - Introduction: plugin_development/index.md
  #   - Creating your first plugin: plugin_development/creating-your-first-plugin.md
  #   - Plugin Views: plugin_development/plugin-views.md
  #   - Manifest Reference: plugin_development/manifest.md
  #   - API Reference: plugin_development/api-reference.md
  #   - Publishing: plugin_development/publishing-plugins.md
  - Support:
    - purchasing/purchasing-a-license.md
    - purchasing/license-types.md
    - Upgrading: support/upgrading-from-the-community-edition.md
    - support/subscription-management.md
    - support/contact-support.md
    - support/open-source.md
    - support/troubleshooting.md
    - support/data-location.md