stow/oh-my-zsh/.oh-my-zsh/plugins/sublime/README.md

   1 # sublime
   2
   3 Plugin for [Sublime Text](https://www.sublimetext.com/), a cross platform text and code editor,
   4 available for Linux, macOS, and Windows.
   5
   6 To use the plugin, add `sublime` to the plugins array of your zshrc file:
   7
   8 ```zsh
   9 plugins=(... sublime)
  10 ```
  11
  12 Sublime Text has to be installed to use the plugin.
  13
  14 ## Usage
  15
  16 The plugin defines several aliases, such as:
  17
  18 - `st`: opens Sublime Text. If passed a file or directory, Sublime Text will open it.
  19
  20 - `stt`: open Sublime Text on the current directory.
  21
  22 - `sst`: if `sudo` is available, `sst` will open Sublime Text with root permissions, so that
  23   you can modify any file or directory that you pass it. Useful to edit system files.
  24
  25 There are also a few functions available:
  26
  27 - `find_project` (or `stp` alias): if called, the function will search for a `.sublime-project` file
  28   on the current directory or its parents, until it finds none.
  29
  30   If there is no `.sublime-project` file but the current folder is in a Git repository, it will open
  31   Sublime Text on the root directory of the repository.
  32
  33   If there is no Git repository, it will then open Sublime Text on the current directory.
  34
  35 - `create_project` (or `stn` alias): if called without an argument, create a stub `.sublime-project`
  36   file in the current working directory, if one does not already exist. If passed a directory, create
  37   a stub `.sublime-project` file in it.