Sublime Forum

How to view/show a package's help?

#1

Probably I’m missing something obvious, but how can I view/show help topics specific to a particular package?
Let’s say I’m installing a new package, e.g. “Outline”. Then I close Sublime Text, and then start it the next day when I already forgot what the “Outline” package is. Now, how can I view the “Outline” package’s help to refresh my memory regarding how to use it?
Currently the only way I’ve found is:

  1. Locate the package under the question (e.g. %USER%\AppData\Roaming\Sublime Text 3\Installed Packages\Outline.sublime-package);
  2. Open this Outline.sublime-package as a ZIP archive;
  3. Open and read the file README.md inside of that archive.

But this way looks too hardcore & oldschool to me… Obviously there must be a simpler way… or not?

0 Likes

#2

https://packagecontrol.io/packages/ReadmePlease

0 Likes

#3

Thank you!
With this package, however, now there’s another challenge: don’t forget about typing “ReadmePlease” in the Command Palette (Ctrl+Shift+P) :slight_smile:

0 Likes

#4

I usually go directly to their repo (usually on github) to read their docs though.

0 Likes