Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaipandya/SublimeTutor
An interactive in-editor keyboard shortcuts tutorial for Sublime Text 3
https://github.com/jaipandya/SublimeTutor
markdown productivity shortcuts sublime-text tutorial vim vimtutor
Last synced: about 1 month ago
JSON representation
An interactive in-editor keyboard shortcuts tutorial for Sublime Text 3
- Host: GitHub
- URL: https://github.com/jaipandya/SublimeTutor
- Owner: jaipandya
- License: mit
- Created: 2015-10-25T19:43:54.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-06-29T20:16:50.000Z (about 4 years ago)
- Last Synced: 2024-07-18T19:19:01.823Z (2 months ago)
- Topics: markdown, productivity, shortcuts, sublime-text, tutorial, vim, vimtutor
- Language: Ruby
- Homepage: https://sublimetutor.com
- Size: 4.18 MB
- Stars: 342
- Watchers: 14
- Forks: 38
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Sublime Tutor
==============
_______. __ __ .______ __ __ .___ ___. _______
/ || | | | | _ \ | | | | | \/ | | ____|
| (----`| | | | | |_) | | | | | | \ / | | |__
\ \ | | | | | _ < | | | | | |\/| | | __|
.----) | | `--' | | |_) | | `----.| | | | | | | |____
|_______/ .___________.________ |.___________.|________|.________|
| | | | | | |/ __ \ | _ \
`---| |----| | | | `---| |----| | | | | |_) |
| | | | | | | | | | | | | /
| | | `--' | | | | `--' | | |\ \----.
|__| \______/ |__| \______/ | _| `._____|
FOR SUBLIME TEXT 3
Sublime Text 3 is a powerful and easy to use text editor. An ultra simple user
interface beautifully hides all the complexity behind. You can start using the
editor without knowing any details, which is great for beginners.
When I started using Sublime Text, I was a migrant from the world of TextMate
and Vim. While a lot of keyboard shortcuts and features were similar to
TextMate, some looked alien as well. Earlier, when I was learning Vim, I had
found vimtutor to be of great help. In my early days with Sublime, I was
looking for a similar solution which could interactively teach new shortcuts
inside the editor itself.
This tutorial is inspired from classic vimtutor. You will get to learn
some handy shortcuts to work with Sublime Text 3. By the end of this tutorial,
you would be familiar with ST's most important and frequently used shortcuts
and features.
The tutorial uses spaced repetition technique to make sure that your newly
acquired skills are well persisted.
Requirements
-------------
You have Sublime Text 3 installed on your system. If not, you can download it
from here: https://www.sublimetext.com/3. In case if you are on version 2, you
can clone this GIT repository on your system and follow the instructions in
`tutorial` directory inside. Some shortcuts and features discussed would be
ST3 only, but you'd know about it then.
Having said that, there is no reason that you should be using Sublime Text 2. A
lot of improvements have been made since the version 2 and the latest version
is stable enough to do most of the things. Unless, your life depends on a plugin
that is only supported by ST2. I can't help you then.
Installation
-------------
Via [Package Control](https://Sublime.wbond.net/):
1. Install [Package Control](https://Sublime.wbond.net/) if already not installed:
https://packagecontrol.io/installation#st3
2. Press Cmd+Shift+P to bring command palette
in front
3. Type `Install Package` and press enter.
4. Search for `Sublime Tutor` and press enter to install the plugin.
### Manual Installation:
1. Make sure you have [git][1] already installed.
2. `cd` into the `Packages` directory of Sublime Text 3. On Mac, it usually
resides at the following path: `~/Library/Application Support/Sublime Text 3
/Packages/`. Alternatively you can open in via a menu item:
`Preferences > Browse Packages...`
3. Once you are inside Packages directory, clone this repository:
`git clone [email protected]:jaipandya/SublimeTutor.git`. Alternatively download and
extract the latest release for your platform here:
https://github.com/jaipandya/SublimeTutor/releases
4. Restart Sublime Text
Getting Started
----------------
If you haven't already, install Sublime Tutor using the installation steps
given above.
Once Sublime Tutor is installed, press Ctrl+Option+K
keyboard shortcut to open this file in Sublime Text. Another option is to go to
`Help > Sublime Tutor` menu option to open this.
Via Command Palette:
1. Cmd+Shift+P to get the command palette in
front.
2. Type `Sublime Tutor`, select the first command that comes up to start the
interactive guide.
Symbols Used in this guide
---------------------------
* `Cmd` – Command Key
* `Ctrl` - Control Key
* `Option` – Option Key
* `Shift` – Shift Key
* `Esc` – Escape Key
* `Return` – Return Key
* `Delete` – Delete / Backspace Key
[1]: https://git-scm.com/ "Git is a version control system"
Contributing
-------------
1. **Give feedback** -
If you went through the course and think a particular thing can be done in
a different way, you want a feature covered, or there was something that you
specially liked, please let me know via a
[tweet](https://twitter.com/jaipandya/) or
[email](mailto:[email protected]?Subject=Feedback%20On%20Sublime%20Tutor)
2. **Issues** -
Found an issue? Typo, error or a topic needs more details, please create an
issue by going to https://github.com/jaipandya/sublimetutor/issues
2. **Pull request** -
Are you comfortable with git? If you know solution to any of the issues
listed above, fork the repository, make your changes and create a PR with
your changes. Refer to the branches section below while making these changes.
### Branches
All osx platform related changes go in the `master` branch of this repository
while all windows / linux related changes go in `win/linux` branch.