STealthy-and-haSTy / hyperhelpcore

A hyperlinked help system for Sublime Text 3

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

HyperHelp and hyperhelpcore

hyperhelpcore is a dependency package for Sublime Text 3 that allows package authors to provide context sensitive, hyperlinked help for their packages that is displayable directly from within Sublime Text itself.

At first startup, hyperhelpcore will generate a HyperHelp package in the InstalledPackages folder to expose the help functionality, and ensure that it is always up to date.

Some packages using hyperhelpcore:

  • SnAPI - View the documentation for Sublime Text directly within Sublime
  • HyperHelpAuthor - Simple authoring tools for hyperhelpcore

NOTE: This is very much still a work in progress and still being actively developed and tweaked. At this point anything and everything is subject to change without notice.


License

Copyright 2017-2019 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.

About

A hyperlinked help system for Sublime Text 3

License:MIT License


Languages

Language:Python 100.0%