diff --git a/docs/extensions-plugins/jetbrains.mdx b/docs/extensions-plugins/jetbrains.mdx index c738b60f4..82938d6b2 100644 --- a/docs/extensions-plugins/jetbrains.mdx +++ b/docs/extensions-plugins/jetbrains.mdx @@ -24,7 +24,7 @@ Using the Pieces for Developers JetBrains Plugin in combination with the Pieces :::info -In order to use the Pieces JetBrains Plugin, you must have Pieces OS. We recommend also using the Pieces for Developers desktop app. +In order to use the Pieces JetBrains Plugin, you must have Pieces OS. We also recommend downloading the Pieces for Developers Desktop App. ::: diff --git a/docs/extensions-plugins/sublime.mdx b/docs/extensions-plugins/sublime.mdx new file mode 100644 index 000000000..a55b34c8b --- /dev/null +++ b/docs/extensions-plugins/sublime.mdx @@ -0,0 +1,179 @@ +--- +title: Pieces for Developers Sublime Plugin +description: Learn about the Pieces Sublime Extension, how it functions, and all you can do with the Sublime Plugin. +--- + +import { pieces_app } from "/src/lib/const"; +import CTAButton from "/src/components/CTAButton"; +import Video from "../../src/components/Video"; +import { MiniSpacer } from "/src/components/Spacers"; + +# Pieces for Developers Sublime Text Plugin + + + + + +The Pieces Sublime plugin is your gateway to managing your saved materials in Pieces directly from within Sublime Text. Seamlessly interact with Pieces OS and enhance your workflow like never before. + +## Getting Started + +### Installation + +:::info + +In order to use the Pieces Sublime Plugin, you must have Pieces OS. We also recommend downloading the Pieces for Developers Desktop App. + +::: + +#### Stable Build (Recommended) + +- Download the [package control](https://packagecontrol.io/installation) +- Open your command palette. You can use the shortcut key combination `Ctrl+Shift+P` on Windows and `Cmd+Shift+P` on macOS. +- Search for `Package Control: Install Package` +- Search for `Pieces` and select it. + +:::tip + +When you first download the package, it will download and install some required dependencies. As a result, you may need to restart Sublime for Pieces to load in. + +::: + +#### Pre-releases + +You can download and checkout some new beta features before releasing. + +- Make sure you have downloaded the [package control](https://packagecontrol.io/installation) +- Download the `Pieces.sublime-package` from [releases](https://github.com/pieces-app/plugin_sublime/releases) on GitHub +- Add `Pieces.sublime-package` to the Installed Packages directory. + - **Windows**: %APPDATA%\Sublime Text\Installed Packages + - **MacOS**: ~/Library/Application Support/Sublime Text 3/Installed Packages + - **Linux**: ~/.config/sublime-text/Installed Packages +- Open Sublime and enjoy the package + +### Initial Setup + +:::info + +While connecting to your personal cloud provides additional features like generating shareable links, backing up your data, and more, it is not required to use Pieces. You can enjoy the core functionalities anonymously without an account. + +::: + +#### Login/Logout + +You can log in and out of your Pieces account using the Pieces: Login or Pieces: Logout command in your command palette. + +