ctrl+shift+p filters: :st2 :st3 :win :osx :linux
浏览

Sublime​Peek

jlegewie 全部

Sublime Text 2 插件,可以通过快捷键快速访问帮助文件(HTML、CSS、JavaScript、PHP、Python、Ruby、R 和 Stata)

详细信息

  • 2015.03.17.12.36.53
    2015.02.25.01.35.17
  • github.com
  • github.com
  • 9年前
  • 26分钟前
  • 12年前

安装次数

  • 总数 5K
  • Win 2K
  • Mac 2K
  • Linux 928
8月7日 8月6日 8月5日 8月4日 8月3日 8月2日 8月1日 7月31日 7月30日 7月29日 7月28日 7月27日 7月26日 7月25日 7月24日 7月23日 7月22日 7月21日 7月20日 7月19日 7月18日 7月17日 7月16日 7月15日 7月14日 7月13日 7月12日 7月11日 7月10日 7月9日 7月8日 7月7日 7月6日 7月5日 7月4日 7月3日 7月2日 7月1日 6月30日 6月29日 6月28日 6月27日 6月26日 6月25日 6月24日
Windows 0 0 0 1 0 0 0 0 0 0 0 0 1 1 0 1 0 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 1 0 0 0 0 0
Mac 0 1 1 0 0 0 0 0 0 1 0 0 0 1 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

源代码
raw.githubusercontent.com

SublimePeek

SublimePeek 通过在 快速预览 中打开帮助文件来提供快速访问文档的功能。插件支持 HTMLCSSJavaScriptPHPPythonRubyRStata。也非常容易添加对新语言的支持。目前,插件只在 Mac OS 上运行,但可以通过 gloobus-preview 在其他 Unix 系统上以及使用 maComfort 在 Windows 上扩展。

支持的编程语言: HTML, CSS, JavaScript, PHP, Python, Ruby, R 和 Stata

安装

(说明复制并修改自 https://github.com/Kronuz/SublimeLinter)

使用 Package Control 插件: 安装 SublimePeek 的一种最简单的方式是通过 Package Control。安装 Package Control 的说明可以在此找到: http://wbond.net/sublime_packages/package_control/installation

安装 Package Control 后,重启 ST2 并打开命令面板 (Command+Shift+P 在 Mac OS 上,Control+Shift+P 在 Linux/Windows 上)。选择“Package Control: Install Package”,等待 Package Control 获取最新的包列表,然后在列表出现时选择 SublimePeek。使用此方法的好处是 Package Control 会自动将 SublimePeek 更新到最新版本。

不使用 Git:GitHub 下载最新源码,并将 SublimePeek 文件夹复制到 Sublime Text 的“包”目录中。

使用 Git: 在 Sublime Text 的“包”目录中克隆仓库: git clone git://github.com/jlegewie/SublimePeek.git

“包”目录位于

  • OS X: ~/Library/Application Support/Sublime Text 2/Packages/
  • Linux: ~/.config/sublime-text-2/Packages/
  • Windows: %APPDATA%/Sublime Text 2/Packages/

Python 和 Ruby

Python 的帮助文件动态生成在 pydoc,Ruby 的帮助文件动态生成在 ri,因此这两个语言应该可以立即使用。

HTML、CSS、JavaScript 和 PHP

HTML、CSS、JavaScript 和 PHP 的帮助文档基于 DocHub。它们需要先下载和编译。SublimePeek 可以为您完成所有工作。因此,只需打开相应的文件,即可开始使用 SublimePeek。第一次使用时,将会询问您是否想要下载和编译文件,这将花费一些时间。

R 和 Stata

对于 R,您必须自己安装帮助文档。它们可以作为Package Control的附加包(代码:SublimePeek-R-help)或从https://github.com/jlegewie/SublimePeek-R-help的单独GitHub仓库中获取。或者,SublimePeek 包含一个帮助编译器,您可以使用它自己创建帮助文档。只需在 help-compiler 文件夹下查找 R-help.r 文件即可。自己编译 R 帮助文档的优点是,SublimePeek-R-help 仓库只包含基础包和ggplot2的帮助文档。使用 R 帮助编译器可创建所有已安装 R 包的帮助文档。

Stata 的帮助文档目前还不是作为单独的包提供,但可以通过 help-compiler 文件夹中的 Stata do-file Stata-help.r 容易地编译。如果人们对这些文件感兴趣,我可以将它们添加为一个额外的 ST2 包。

使用 SublimePeek

只需选择一个函数,然后按 super+shift+h。如果语言受 SublimePeek 支持,您现在应该看到一个快照窗口,其中包含关于该函数的文档。实际上,您不必选择该函数。SublimePeek 会自动使用当前光标位置或括号 ( 之前的位置的单词。但 json.lo|ad 不起作用,因为点中断了单词。如果找不到帮助文档,SublimePeek 会显示所有可用帮助文档的概述,用户可以快速选择。

帮助文档概述

对于除 Python 和 Ruby 之外的所有语言,SublimePeek 可以根据熟悉的 ST2 快速选择面板(与命令面板相同,或用于从项目跳转到项目的面板)显示所有可用帮助主题的概述。如果当前选择没有匹配的帮助文档,SublimePeek 会显示概述。要直接显示概述,只需确保当前选择不具有意义,您可以迅速浏览所有帮助主题。

支持 Unix 和 Windows

目前,该插件仅适用于 Mac OS,但它可以通过 gloobus-preview 扩展到其他 Unix 系统,并通过 maComfort 扩展到 Windows 系统。我本人没有 Unix 或 Windows 系统,但添加支持应该相当简单。给我发邮件,我们可以让它工作!

支持其他语言

添加对其他语言的支持很简单。您需要的是像相应函数一样命名的帮助文档(即每个函数一个帮助文档)或通过简单的 JSON 数据库链接到函数名称的帮助文档。对于 R,我使用一个简单的脚本生成了这些帮助文档,该脚本遍历所有已安装包中的所有对象,并提取每个函数的帮助文档(请参阅 help-compiler 文件夹中的 R-help.r 文件)。这些文件应具有 Quick Look(Mac)、gloobus-preview(Linux)和 maComfort(Windows)支持的格式,例如 html 或简单的文本文件。当有人想添加对其他语言的支持时,我很乐意提供更多信息。