beekeeper-studio · rathboma · Dec 20, 2023 · Dec 18, 2023 · Dec 18, 2023 · Dec 19, 2023
diff --git a/.editorconfig b/.editorconfig
@@ -7,3 +7,8 @@ indent_style = space
 indent_size = 2
 charset = utf-8
 trim_trailing_whitespace = true
+
+# Matches files under the docs directory
+[docs/**.*]
+indent_style = space
+indent_size = 4
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 .idea/
+.cache/
 .vscode/
 ./data/
 node_modules/

diff --git a/apps/studio/docs/troubleshooting/README.md b/apps/studio/docs/troubleshooting/README.md
@@ -7,8 +7,6 @@ title: Troubleshooting
 
 Hopefully you can solve your problems with the details below. If not please [contact us][/contact/] and we'll try our best to help.
 
-[[toc]]
-
 ## Don't be shy, say hi!
 
 Feel free to file an issue or start a discussion, even if you're not sure if something is wrong. We're a super nice community, and we all help each other out.

diff --git a/docs/Advanced/deep-dive-overview.md b/docs/Advanced/deep-dive-overview.md
@@ -0,0 +1,24 @@
+---
+title: Data Storage Location
+summary: "Where Beekeeper Studio stores your SQL queries and connections when you save them."
+old_url: "https://docs.beekeeperstudio.io/docs/deep-dive-overview"
+---
+
+When you save connections and SQL queries in Beekeeper Studio they are persisted to a SQLite database in the application configuration directory.
+
+## Database Location
+
+The database is named `app.db` and is stored in the `userData` folder which the operating system provides for Beekeeper Studio to store settings and preferences.
+
+### UserData directory locations:
+
+- Windows: `<User Directory>\AppData\Roaming\beekeeper-studio`
+- MacOS: `~/Library/Application Support/Beekeeper Studio`
+- Linux: `~/.config/beekeeper-studio`
+
+
+## Access the Beekeeper Studio Database....From Beekeeper Studio
+
+If you navigate to `Help -> Add Beekeeper's Database` the app will add a new database connection for you to use - Beekeeper's database itself.
+
+You can use this connection to explore your saved data, export SQL queries, or do whatever you need.
diff --git a/docs/assets/bks.svg b/docs/assets/bks.svg
diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico
diff --git a/docs/assets/images/backup-restore-152.png b/docs/assets/images/backup-restore-152.png
diff --git a/docs/assets/images/backup-restore-153.png b/docs/assets/images/backup-restore-153.png
diff --git a/docs/assets/images/backup-restore-154.png b/docs/assets/images/backup-restore-154.png
diff --git a/docs/assets/images/backup-restore-89.png b/docs/assets/images/backup-restore-89.png
diff --git a/docs/assets/images/backup-restore-90.png b/docs/assets/images/backup-restore-90.png
diff --git a/docs/assets/images/backup-restore-91.png b/docs/assets/images/backup-restore-91.png
diff --git a/docs/assets/images/backup-restore-92.png b/docs/assets/images/backup-restore-92.png
diff --git a/docs/assets/images/backup-restore-93.png b/docs/assets/images/backup-restore-93.png
diff --git a/docs/assets/images/backup-restore-94.png b/docs/assets/images/backup-restore-94.png
diff --git a/docs/assets/images/cloud-storage-team-workspaces-28.png b/docs/assets/images/cloud-storage-team-workspaces-28.png
diff --git a/docs/assets/images/creating-tables-14.png b/docs/assets/images/creating-tables-14.png
diff --git a/docs/assets/images/creating-tables-95.png b/docs/assets/images/creating-tables-95.png
diff --git a/docs/assets/images/creating-tables-96.gif b/docs/assets/images/creating-tables-96.gif
diff --git a/docs/assets/images/creating-tables-97.gif b/docs/assets/images/creating-tables-97.gif
diff --git a/docs/assets/images/creating-tables-98.gif b/docs/assets/images/creating-tables-98.gif
diff --git a/docs/assets/images/data-export-156.gif b/docs/assets/images/data-export-156.gif
diff --git a/docs/assets/images/data-export-157.png b/docs/assets/images/data-export-157.png
diff --git a/docs/assets/images/data-export-23.png b/docs/assets/images/data-export-23.png
diff --git a/docs/assets/images/data-export-24.png b/docs/assets/images/data-export-24.png
diff --git a/docs/assets/images/data-export-25.png b/docs/assets/images/data-export-25.png
diff --git a/docs/assets/images/data-export-26.png b/docs/assets/images/data-export-26.png
diff --git a/docs/assets/images/data-export-27.gif b/docs/assets/images/data-export-27.gif
diff --git a/docs/assets/images/editing-data-18.png b/docs/assets/images/editing-data-18.png
diff --git a/docs/assets/images/editing-data-19.png b/docs/assets/images/editing-data-19.png
diff --git a/docs/assets/images/editing-data-20.gif b/docs/assets/images/editing-data-20.gif
diff --git a/docs/assets/images/editing-data-21.png b/docs/assets/images/editing-data-21.png
diff --git a/docs/assets/images/editing-data-22.png b/docs/assets/images/editing-data-22.png
diff --git a/docs/assets/images/first-page-5.png b/docs/assets/images/first-page-5.png
diff --git a/docs/assets/images/first-page-6.png b/docs/assets/images/first-page-6.png
diff --git a/docs/assets/images/first-page-7.png b/docs/assets/images/first-page-7.png
diff --git a/docs/assets/images/first-page-8.png b/docs/assets/images/first-page-8.png
diff --git a/docs/assets/images/getting-started-guide-60.gif b/docs/assets/images/getting-started-guide-60.gif
diff --git a/docs/assets/images/getting-started-guide-61.gif b/docs/assets/images/getting-started-guide-61.gif
diff --git a/docs/assets/images/google-bigquery-100.png b/docs/assets/images/google-bigquery-100.png
diff --git a/docs/assets/images/google-bigquery-101.png b/docs/assets/images/google-bigquery-101.png
diff --git a/docs/assets/images/importing-data-csv-json-etc-844e-148.png b/docs/assets/images/importing-data-csv-json-etc-844e-148.png
diff --git a/docs/assets/images/importing-data-csv-json-etc-844e-149.png b/docs/assets/images/importing-data-csv-json-etc-844e-149.png
diff --git a/docs/assets/images/importing-data-csv-json-etc-844e-150.png b/docs/assets/images/importing-data-csv-json-etc-844e-150.png
diff --git a/docs/assets/images/importing-data-csv-json-etc-844e-151.png b/docs/assets/images/importing-data-csv-json-etc-844e-151.png
diff --git a/docs/assets/images/introduction-1.png b/docs/assets/images/introduction-1.png
diff --git a/docs/assets/images/linux-4.png b/docs/assets/images/linux-4.png
diff --git a/docs/assets/images/macos-m1-intel-10.png b/docs/assets/images/macos-m1-intel-10.png
diff --git a/docs/assets/images/macos-m1-intel-3.png b/docs/assets/images/macos-m1-intel-3.png
diff --git a/docs/assets/images/oracle-database-62.png b/docs/assets/images/oracle-database-62.png
diff --git a/docs/assets/images/query-magics-15.png b/docs/assets/images/query-magics-15.png
diff --git a/docs/assets/images/query-magics-16.png b/docs/assets/images/query-magics-16.png
diff --git a/docs/assets/images/query-magics-17.png b/docs/assets/images/query-magics-17.png
diff --git a/docs/assets/images/query-magics-84.png b/docs/assets/images/query-magics-84.png
diff --git a/docs/assets/images/query-magics-85.png b/docs/assets/images/query-magics-85.png
diff --git a/docs/assets/images/query-magics-86.png b/docs/assets/images/query-magics-86.png
diff --git a/docs/assets/images/sqlite-88.png b/docs/assets/images/sqlite-88.png
diff --git a/docs/assets/images/troubleshooting-58.png b/docs/assets/images/troubleshooting-58.png
diff --git a/docs/assets/images/using-the-sql-editor-11.gif b/docs/assets/images/using-the-sql-editor-11.gif
diff --git a/docs/assets/images/using-the-sql-editor-12.gif b/docs/assets/images/using-the-sql-editor-12.gif
diff --git a/docs/assets/images/using-the-sql-editor-13.gif b/docs/assets/images/using-the-sql-editor-13.gif
diff --git a/docs/assets/images/using-the-sql-editor-155.png b/docs/assets/images/using-the-sql-editor-155.png
diff --git a/docs/assets/images/using-the-sql-editor-99.png b/docs/assets/images/using-the-sql-editor-99.png
diff --git a/docs/getting-started-guide.md b/docs/getting-started-guide.md
@@ -0,0 +1,104 @@
+---
+title: Beginners Guide
+summary: "This guide will help you setup and use Beekeeper Studio for the first time. Don't worry, it's pretty painless. :-)"
+old_url: "https://docs.beekeeperstudio.io/docs/getting-started-guide"
+---
+
+👋 Hello and welcome to the Beekeeper Studio community. I think you're going to like it here.
+
+Beekeeper Studio is more than an app, come say hi:
+
+- [Join the community Slack group](https://beekeeperstudio.io/slack)
+- [Explore feature requests on Github](https://github.com/beekeeper-studio/beekeeper-studio)
+
+
+
+!!! note "Hey there!"
+    This page will help you get familiar with Beekeeper Studio. If you've used similar applications in the past, feel free to explore the rest of the documentation site, or just start using Beekeeper Studio (it's pretty intuitive!)
+
+
+If you're new to database management apps in general it might help to watch this walkthrough of Beekeeper Studio, I go through a bunch of major features
+
+<iframe width="100%" height="315" src="https://www.youtube-nocookie.com/embed/id37-ZRZNkQ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
+
+👉  [Watch the Beekeeper Studio Walkthrough on YouTube](https://www.youtube.com/watch?v=id37-ZRZNkQ)
+
+## First step - install Beekeeper Studio
+
+
+Beekeeper Studio is a desktop application, so the first step is to [Install Beekeeper Studio](./installation/index.md)
+
+
+
+## Lets explore Beekeeper Studio with a demo database
+
+A quick and easy way to explore Beekeeper Studio's functionality is with the `Sakila` demo database -- it's a sample database modeling an old-school DVD rental store, like a Blockbuster.
+
+
+!!! tip "Experts can skip to the end"
+    If you already have a database you want to view, edit, and query, hop to it!
+
+    These topics will help you get started with the most commonly used features of Beekeeper Studio
+
+    - [Connecting to a database](./user_guide/connecting/first-page.md)
+    - [Write some SQL](./user_guide/using-the-sql-editor.md)
+    - [Browse and edit table data](./user_guide/editing-data.md)
+    - [Create & modify tables](./user_guide/modify-tables.md)
+
+
+### Getting started with Sakila and Beekeeper Studio
+
+1. Make sure you have Beekeeper Studio [downloaded and installed](./installation/index.md)
+1. [Download the Sakila database](https://github.com/ivanceras/sakila/raw/master/sqlite-sakila-db/sakila.db) - this is a `.db` file - a self contained SQLite database file.
+2. Double click the `sakila.db` file you just downloaded.
+
+Beekeeper will open, showing you the contents of the database:
+
+![Opening the demo database in Beekeeper Studio](./assets/images/getting-started-guide-60.gif)
+
+### Open a table and change some data
+
+Double click on the `film` table in the left sidebar. This will open the data view for that table.
+
+Remember - this is just a demo database, you can do whatever you like to it without any risk. Try clicking on the `title` cell for a movie and changing the movie name. You can save your changes by clicking the `apply` button in the footer.
+
+
+![Click apply to save changes](./assets/images/getting-started-guide-61.gif)
+
+### Write your first SQL query
+
+Now you know how to view and edit table data, why not write some custom SQL to pull some interesting data out of the database.
+
+Here's a sample query to count the number of films in the database grouped by rating (like PG-13):
+
+```sql
+SELECT
+    film.rating, COUNT(DISTINCT inventory.film_id) AS film_count
+    FROM film JOIN inventory
+    ON film.film_id = inventory.film_id
+    GROUP BY film.rating
+    ORDER BY COUNT(inventory.film_id) DESC
+```
+
+Executing this produces the below result:
+
+| rating | film_count |
+|--------|------------|
+| PG-13  | 213        |
+| NC-17  | 202        |
+| PG     | 183        |
+| R      | 189        |
+| G      | 171        |
+
+### Explore other Beekeeper Studio Features
+
+It's time to fly the nest and explore Beekeeper Studio on your own 🕊.
+
+- Try [creating a new table](./user_guide/modify-tables.md)
+- Maybe [export some data to Excel](./user_guide/data-export.md)
+- Also checkout [beautifying your results with Query Magics](./user_guide/query-magics.md)
+
+
+## Reach out if you need help
+
+Stuck? Confused? Email us and we'll help - [support@beekeeperstudio.io](mailto:support@beekeeperstudio.io)
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,40 @@
+---
+title: Introduction to Beekeeper Studio
+summary: "Beekeeper Studio is a modern and easy to use SQL GUI and database manager available for MacOS, Windows, and Linux. "
+old_url: "https://docs.beekeeperstudio.io/docs/introduction"
+---
+
+## What is Beekeeper Studio?
+
+Beekeeper Studio is a database manager and SQL GUI. It is a desktop app that is easy to use. It's a visual alternative to command line tools like `psql` or `mysql`, while also providing a bunch of useful extra features.
+
+
+Beekeeper Studio comes in two editions:
+- **Beekeeper Studio** - The full version of Beekeeper Studio.
+- **Beekeeper Studio Community Edition** - A free and open source version of Beekeeper Studio that supports fewer databases and contains fewer features.
+
+These docs and the main website primarily talk about features of the full commercial edition of Beekeeper Studio. See [GitHub](https://github.com/beekeeper-studio/beekeeper-studio) for information on the community edition.
+
+
+![Beekeeper Studio preview](./assets/images/introduction-1.png)
+
+
+### Databases Supported by Beekeeper Studio
+
+Currently Beekeeper supports the following database types:
+
+- PostgreSQL
+- SQLite
+- MySQL
+- MariaDB
+- SQL Server
+- Amazon Redshift
+- CockroachDB
+- Oracle Database
+- Google BigQuery
+- Apache Cassandra
+
+### Platforms Supported by Beekeeper Studio
+
+Beekeeper Studio is available for laptops and desktops running MacOS, Windows, or Linux. Unfortunately we do not currently have any plans to port Beekeeper Studio to iOS or Android devices.
+
diff --git a/docs/installation/index.md b/docs/installation/index.md
@@ -0,0 +1,13 @@
+---
+title: Overview
+summary: "How to install Beekeeper Studio"
+old_url: "https://docs.beekeeperstudio.io/docs/overview"
+---
+
+Beekeeper Studio is available for Windows, Linux, and MacOS
+
+See the guides below for OS specific installation instructions:
+
+- [Windows](./windows.md)
+- [Mac OS (Intel and Apple Silicon)](./macos-m1-intel.md)
+- [Linux](./linux.md)
diff --git a/docs/installation/linux.md b/docs/installation/linux.md
@@ -0,0 +1,75 @@
+---
+title: Linux
+summary: "How to install Beekeeper Studio on Linux systems"
+old_url: "https://docs.beekeeperstudio.io/docs/linux"
+---
+
+
+There are several ways to install Beekeeper Studio on Linux systems.
+
+Supported Architectures: `x86-64` (most laptops and desktops) and `ARM64` (Raspberry Pi).
+
+!!! info "We recommend using AppImage"
+    We find they provide the most consistent experience across all Linux distributions.
+
+## AppImage
+
+AppImages can be downloaded and run directly on most Linux distributions without any sort of installation. This is great if you don't have root access, but still want to use Beekeeper Studio.
+
+The AppImage distribution of Beekeeper Studio provides automatic updates.
+
+Download the latest AppImage [from the Beekeeper Studio homepage](https://www.beekeeperstudio.io/)
+
+If you want to integrate the AppImage into your system shell (so it appears in your Application menu), we recommend you [install AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher/releases/latest).
+
+## Apt / DEB
+A repo is provided for Debian and Ubuntu 16.04+.
+
+```bash
+# Install our GPG key
+wget --quiet -O - https://deb.beekeeperstudio.io/beekeeper.key | sudo apt-key add -
+
+# add our repo to your apt lists directory
+echo "deb https://deb.beekeeperstudio.io stable main" | sudo tee /etc/apt/sources.list.d/beekeeper-studio-app.list
+
+# Update apt and install
+sudo apt update
+sudo apt install beekeeper-studio
+
+```
+
+
+## Snap Store / Ubuntu Store
+
+You can also install Beekeeper Studio through Snapcraft (also part of the Ubuntu Store). Use either the Snap Store link below, or install through the terminal.
+
+!!! warning
+    Some features are unavailable in the Snap version of Beekeeper Studio due to the security model of Snap packages.
+
+`snap` is pre-installed on Ubuntu 16.04+, and can be installed on [Fedora](https://snapcraft.io/docs/installing-snap-on-fedora), and [Arch](https://snapcraft.io/docs/installing-snap-on-arch-linux)
+
+View Beekeeper in the [Snap Store](https://snapcraft.io/beekeeper-studio), or install using the terminal:
+
+```bash
+sudo snap install beekeeper-studio
+```
+
+### Font Rendering Issues
+
+There are some font-rendering issues with Snaps on the latest version of Gnome with the `snap` version of Beekeeper Studio. This is only really visible in the file-select screen. [Hopefully it will be fixed soon](https://forum.snapcraft.io/t/snapped-app-not-loading-fonts-on-fedora-and-arch/12484/66)
+
+If you see something like this, we recommend you move to the [AppImage](#appimage) version instead.
+
+
+
+![Image Alt Tag](../assets/images/linux-4.png)
+Font rendering issues in Gnome 3.38+ with the snap package
+{: .text-muted .small .text-center }
+
+
+### SSH Key Access For The Snap
+Due to the Snap security model, you need to manually enable access to the .ssh directory if you want to use SSH tunneling.
+Run `sudo snap connect beekeeper-studio:ssh-keys :ssh-keys`.
+
+- **SSH Agent**: Unfortunately, Snaps have no way to access your SSH Agent, so if you need to use the SSH agent we recommend you use the `deb` or `AppImage` version of the app.
+
diff --git a/docs/installation/macos-m1-intel.md b/docs/installation/macos-m1-intel.md
@@ -0,0 +1,25 @@
+---
+title: MacOS (M1 & Intel)
+summary: "How to install Beekeeper Studio on MacOS. Beekeeper Studio supports both Intel and M1 processors."
+old_url: "https://docs.beekeeperstudio.io/docs/macos-m1-intel"
+---
+
+
+## Download From Our Website
+To install Beekeeper Studio download the `dmg` installer file from [our website](https://beekeeperstudio.io), then drag the Beekeeper Studio application into your application drawer.
+
+Note that by default MacOS will prevent you from installing third-party distributed apps (through the Mac app store). To enable this, navigate to `Settings -> Security and Privacy`, and enable `App Store and Identified Developers`:
+
+## Apple Silicon vs Intel
+
+Beekeeper Studio installers are available for both Intel and Apple silicon Macs. You can choose your preferred installer type when downloading from the website.
+
+!!! warning "Oracle Database Libraries Do Not Support Apple Silicon"
+    Oracle Database libraries and packages are **not** available yet for Apple Silicon. So if you want to connect Beekeeper Studio to your Oracle Database you must install the Intel version of Beekeeper Studio and [run it in Rosetta 2](https://support.apple.com/en-us/HT211861)
+
+
+### Choose Your Architecture
+When downloading Beekeeper Studio, be sure to choose the version that matches your MacOS architecture.
+![Image Alt Tag](../assets/images/macos-m1-intel-10.png)
+
+
diff --git a/docs/installation/windows.md b/docs/installation/windows.md
@@ -0,0 +1,18 @@
+---
+title: Windows
+summary: "How to install Beekeeper Studio on Windows"
+old_url: "https://docs.beekeeperstudio.io/docs/windows"
+---
+
+## Simply Download And Run
+
+
+Download and run the Windows installer from [our website](https://beekeeperstudio.io).
+
+Currently Beekeeper Studio only supports the `x86_64` architecture. Support for `ARM64` will come in a future release.
+
+
+## Portable Version of Beekeeper Studio
+
+We also have a portable version of Beekeeper Studio that does not require installation. This is also available from our website.
+
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -0,0 +1,36 @@
+:root {
+  /* --md-hue: 225deg;
+  --md-accent-fg-color: #FAD83B;
+  --md-accent-fg-color--transparent: #fad73b58;
+
+
+
+
+  --md-primary-fg-color: hsla(var(--md-hue), 15%, 9%, 1);
+  --md-primary-fg-color--light: hsla(var(--md-hue), 15%, 9%, 0.54);
+  --md-primary-fg-color--dark: hsla(var(--md-hue), 15%, 9%, 1);
+  --md-primary-bg-color: hsla(var(--md-hue), 15%, 100%, 1);
+  --md-primary-bg-color--light: hsla(var(--md-hue), 15%, 100%, 0.7); */
+
+    --md-hue: 225deg;
+    --md-accent-fg-color: #fad83b;
+    --md-accent-fg-color--transparent: #fad73b 58;
+    --md-primary-fg-color: #2c2c2c;
+    --md-primary-fg-color--light: lightblue;
+    --md-primary-fg-color--dark: darkblue;
+    --md-primary-bg-color: white;
+    --md-primary-bg-color--light: #fad83b;
+
+
+}
+[data-md-color-scheme="slate"] {
+  --md-typeset-a-color: var(--md-accent-fg-color);
+  --md-default-bg-color: #1a1a1a;
+  --md-typeset-color: rgba(255, 255, 255, 0.72);
+  --md-default-fg-color--light: white;
+
+}
+
+
+
+