jaipandya / sublimetutor Goto Github PK

View Code? Open in Web Editor NEW

340.0 14.0 38.0 4.28 MB

An interactive in-editor keyboard shortcuts tutorial for Sublime Text 3

Home Page: https://sublimetutor.com

License: MIT License

Python 38.67% Ruby 61.33%

sublime-text shortcuts vimtutor tutorial vim markdown productivity

sublimetutor's Introduction

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:

Install Package Control if already not installed: https://packagecontrol.io/installation#st3
Press Cmd+Shift+P to bring command palette in front
Type Install Package and press enter.
Search for Sublime Tutor and press enter to install the plugin.

Manual Installation:

Make sure you have git already installed.
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...
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
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:

Cmd+Shift+P to get the command palette in front.
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

Contributing

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 or email
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
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.

sublimetutor's People

Contributors

Stargazers

Watchers

sublimetutor's Issues

URL Typo on Medium Article

The Medium article here

links to here (https://subliemtutor.com/)

and not here (https://sublimetutor.com/).

The bad text is

Introducing Sublime Tutor for Sublime Text 3

, which leads to the bad link

chapter_5_3.mg Replace Next in the Exercise

Thanks for the very useful tutorial.

typo in 5_3 for WIndows:

I am working on Windows 10. In chapter_5_3, in the Exercise at the end (point 6, line 72) it mentions the shortcut to replace next is Ctrl + Shift + E while it should be Ctrl + Shift + H. I saw the source file reflecting this correctly for Mac, so I think it is rendered wrong for Windows,

Some minor comments about 5_2:

For 5_2 I would like to suggest an addition to the end of the third paragraph (the one starting at line 14: These commands...):
"regular find Esc key plays that role"while here it just exit the panel without moving the cursor.

I know it is explained in the Exercise, But I feel it should be explained in the start clearly that Ctrl + I opens the panel first time it is pressed:

Let's learn the shortcuts first:

* Incremental find panes - `Ctrl + I` 
* Incremental find next  - `Ctrl + I` (While panel is open)
* Incremental find previous - `Ctrl + Shift + I`

And maybe mention that Ctrl + E works much better with regular Find.

Thanks

Wrong sorting of chapters

Hey! Right now it goes like this:

chapter_1.md
chapter_2.md
chapter_2_1.md
chapter_2_10.md
...

Note that 10 comes after 1, which is incorrect (seems like Sublime is not using numeric sorting of files).
What do you think about adding leading zeroes to fix it and make it like that?

chapter_01.md
chapter_02.md
chapter_02_01.md
chapter_02_02.md
chapter_02_03.md
...
chapter_02_10.md
...

Not found in Package Control

As written in the title above, I can't find Sublime tutor via Package Control.
Is there a problem or is it only me?

SherzmisticTanz

GitHub.com has an issue, I just wanted to say thanks to each and everyone of you that helped me with this, I could not do this without you, you have inspired me to go back to school and learn more. So much work put into this, I truly had given up on it!

Wrong chapter number at 3.1

In the end of chapter 3.1, it tells us to go to chapter 3.1. It should tell us to go to chapter 3.2

Let's go to the next chapter chapter_3_1.md which will introduce us to column
selection techniques.

Wrong shortcut in Chapter 2_2

Exercise 2 should be Option + Delete and not Cmd + Delete. Cmd + Delete deletes from the cursor to the beginning of the line.

chapter_2_4 Ex.2 - instructions add too many newlines

When following the instructions in Chapter 2_4, Exercise 2, using Cmd + X already cuts the newline character as well.

Pasting the line from the clipboard with Cmd + V is therefore enough.

Additionally using Cmd + Return to enter a new line before pasting creates unnecessary line breaks that need to be cleaned up to make it look clean and consistent.

typo in tuturial

Hi there,

Branch: win/linux
File: chapter_5_1.md

4.Cycle in the opposite order using Alt + F3, press this multiple times
until you get comfortable with this command.

Should be: Shift + F3

Wrong symlink name in README

Make a symlink to `subl`. Assuming you've placed Sublime Text in `Applications`
folder on Mac, and that you have ~/bin directory in your `PATH`, you can run:

    $ ln -s "/Applications/Sublime Text.app/Contents/SharedSupport/bin/subl" /usr/local/bin/Sublime

Now you can use `sublime` command in your terminal to open Sublime Text 3. If 
you put a `.` after the command, it will open the current directory in Sublime.

    $ sublime

or

    $ sublime .

It seems that it should be $ subl and $ subl . respectively.

Uncommenting not working in Chapter 2.12

Maybe I'm doing something wrong here, but uncommenting with Cmd+/ doesn't seem to be working in chapter 2.12. All I'm getting is successive layers of HTML-styled comments.

For example, I go from:

to:

 -->

And I keep adding further layers of comment tags from there. Should I be doing something else here? I'm running Sublime Text build 3142 on macOS 10.12.6, if it matters.

`CTRL + J` functionality changed

Windows chapter_2_7 (Joining lines) states that CTRL + J will join lines together. That is no longer the case, and should be changed to CRTL + SHIFT + J.

Pressing CTRL + J now gives this pop-up.

Also see this post

2_12 error?

On my macbook air w/ SublimeText 3114, CMD+/ just comments the line repeatedly instead of toggling commenting. If I press CMD+/ 4 times on that third line in the html code, I end up with:

 --> --> -->

Del

Installed, but won't launch

I went through the steps to install SublimeTutor but when I attempt to launch it I see:

Traceback (most recent call last):
  File "./sublime_plugin.py", line 339, in run_
  File "./sublime_tutor.py", line 19, in run
AttributeError: 'module' object has no attribute 'executable_path'