If you leave out this parameter, the table of contents for the Hammerspoon built-in documentation is displayed instead. an optional string specifying a Hammerspoon module, function, or method to display documentation for.This behavior is triggered automatically, regardless of this setting, if you are running with a version of OS X prior to 10.10, since hs.webview requires OS X 10.10 or later.Ĭhanges made with this function are saved with hs.settings with the label "_documentationServer.forceExternalBrowser" and will persist through a reload or restart of Hammerspoon.ĭisplay the documentation for the specified Hammerspoon function, or the Table of Contents for the Hammerspoon documentation in a built-in mini browser. The string should match one of the items returned by hs.urlevent.getAllHandlersForScheme("http"). If this value is set to a string, the string specifies the bundle ID of an application which will be used to handle the url request for the documentation. If this value is set to true, help requests invoked by hs. will be invoked by your system's default handler for the http scheme. value - an optional boolean or string, default false, specifying whether or not documentation requests will be displayed in an external browser or the internal one handled by hs.webview.Get or set whether or not hs. uses an external browser. If hs. is true, then this any value set with this function will be overwritten whenever the browser window is moved or resized.Ĭhanges made with this function are saved with hs.settings with the label "_documentationServer.browserFrame" and will persist through a reload or restart of Hammerspoon. If hs. is false or nil (the default), then you can use this function to specify the initial position of the documentation browser. frameTable - a frame table containing x, y, h, and w values specifying the browser's initial position when Hammerspoon starts.Get or set the currently saved initial frame location for the documentation browser. Inversion is applied through the use of CSS filtering, so while numeric values other than 0 (false) and 100 (true) are allowed, the result is generally not what is desired.Ĭhanges made with this function are saved with hs.settings with the label "_documentationServer.invertDocs" and will persist through a reload or restart of Hammerspoon. if the value is a number between 0 and 100, the number specifies the inversion ratio, where 0 means no inversion, 100 means full inversion, and 50 is completely unreadable because the foreground and background are equally adjusted.if value is nil, then the output will be inverted only when the OS X theme is set to Dark mode.if value is false, then the HTML output will never be inverted.if value is true, then the HTML output will always be inverted.value - an optional boolean, number, or nil specifying whether or not the documentation browser renders in Dark mode.Get or set whether or not the Hammerspoon browser renders output in Dark mode. Functions - API calls offered directly by the extensionĪPI Documentation Functions browserDarkMode Signature.As always, the most current and official documentation can be found at and in the official Hammerspoon Dash docset. The intent of this sub-module is to provide as close a rendering of the same documentation available at the Hammerspoon GitHub site and Dash documentation as possible in a manner suitable for run-time modification so module developers can test out documentation additions without requiring a complete recompilation of the Hammerspoon source. Documentation for the LuaSkin Objective-C Framework.Markdown/HTML based tutorials and How-To examples.
0 Comments
Leave a Reply. |