https://github.com/STealthy-and-haSTy/SnAPI

View Sublime Text 3 API documentation directly from within Sublime Text.
https://github.com/STealthy-and-haSTy/SnAPI

api-documentation package sublime-text-3 sublime-text-plugin

Last synced: about 2 months ago
JSON representation

View Sublime Text 3 API documentation directly from within Sublime Text.

• Host: GitHub
• URL: https://github.com/STealthy-and-haSTy/SnAPI
• Owner: STealthy-and-haSTy
• License: other
• Created: 2017-06-17T04:07:57.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-07-30T16:39:45.000Z (about 4 years ago)
• Last Synced: 2024-05-30T02:18:15.461Z (4 months ago)
• Topics: api-documentation, package, sublime-text-3, sublime-text-plugin
• Language: Python
• Size: 191 KB
• Stars: 13
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

README

        
SnAPI

=====

SnAPI is a simple package that provides a local copy of the Sublime Text

[documentation](http://www.sublimetext.com/docs/) directly

from within Sublime, using the [hyperhelp](https://github.com/STealthy-and-haSTy/hyperhelpcore)

help system for navigation.

 > ***Note:*** Currently only the Sublime Text API, build system  and color

 > theme documentation is in place in SnAPI. Other reference help from the

 > official documentation set is still forthcoming.

SnAPI is pronounced "Snappy", as having API documentation readily available from

directly within Sublime keeps you focused on your coding. Also it was a name

suggested to me that stuck in my head. Please blame @kingkeith for suggesting

the name and my brain for latching onto it so completely.

Also, please note that all help text and documentation is taken directly from

the above linked official API reference and is Copyright © Sublime HQ Pty Ltd.

-------------------------------------------------------------------------------

**NOTE:** Although there is only help contained within the package, it is still

in active development and as such everything is subject to change.

-------------------------------------------------------------------------------

## License ##

Note that the license below *DOES NOT* include any of the help files, which are

taken from the official Sublime Text documentation at

http://www.sublimetext.com/docs/ and are Copyright © Sublime HQ Pty Ltd.

All other content in this package are licensed under the MIT License:

Copyright 2017-2020 Terence Martin

Permission is hereby granted, free of charge, to any person obtaining a copy of

this software and associated documentation files (the "Software"), to deal in

the Software without restriction, including without limitation the rights to

use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies

of the Software, and to permit persons to whom the Software is furnished to do

so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.