https://github.com/tiansh/us-guide

用户脚本安装的帮助页面
https://github.com/tiansh/us-guide

Last synced: 23 days ago
JSON representation

用户脚本安装的帮助页面

• Host: GitHub
• URL: https://github.com/tiansh/us-guide
• Owner: tiansh
• License: mpl-2.0
• Created: 2015-05-29T13:35:39.000Z (over 9 years ago)
• Default Branch: gh-pages
• Last Pushed: 2017-10-14T12:30:04.000Z (about 7 years ago)
• Last Synced: 2023-04-09T23:59:41.423Z (over 1 year ago)
• Language: HTML
• Size: 50.8 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.mediawiki
  • License: LICENSE

Awesome Lists containing this project

README

        
= 用户脚本安装的帮助页面 =

这里是一个简易的供用户安装用户脚本的网页框架。


可以在网页的锚点中设置参数来针对特定脚本显示安装帮助，也可以用iframe嵌入到别的网页中来减少重复工作。

== 单独的网页 ==

例如如下链接会展示如何安装知乎免登录脚本


http://tiansh.github.io/us-guide/install.html#name=%E7%9F%A5%E4%B9%8E%E5%85%8D%E7%99%BB%E5%BD%95&installurl=https://tiansh.github.io/us-else/zhihu_visitor/Zhihu_Visitor.user.js&description=%E6%9F%A5%E7%9C%8B%E5%AE%8C%E6%95%B4%E7%9A%84%E5%9B%9E%E7%AD%94%E8%80%8C%E6%97%A0%E9%9C%80%E6%B3%A8%E5%86%8C%E7%99%BB%E5%BD%95&author=tiansh&version=2.1&supporturl=https://github.com/tiansh/us-else/issues&homepageurl=https://tiansh.github.io/us-else/zhihu_visitor/&compatible=firefox+greasemonkey&compatible=chrome+tampermonkey&compatible=opera+tampermonkey&color=#EEF2F5,#000,#026B76,#298BD8,#fff


== 嵌入到其他网页中 ==

除了作为单独的网页显示外，该网页还可以用于嵌入到其他网页中。嵌入后将只显示针对浏览器的操作说明。

例如使用如下代码可以将上述网页嵌入到其他网页中：


window.addEventListener('message', function (e) { if (e.origin === 'https://tiansh.github.io') try { install.height = JSON.parse(e.data).installheight } catch (ex) { } }, false);


效果见 https://tiansh.github.io/us-else/zhihu_visitor/index.html

== 锚点参数 ==

网页的各项参数说明如下

* '''name'''：（必填）脚本的名称

* '''installurl'''：（必填）脚本的安装地址，必须是 .user.js 文件

* '''description'''：（可选）脚本的描述

* '''author'''：（可选）脚本的作者

* '''version'''：（可选）脚本的版本

* '''supporturl'''：（可选）脚本的支持页面，一般对应 issue 页面

* '''homepageurl'''：（可选）脚本的主页

* '''compatible'''：（可选，可重复）格式为`浏览器`或`浏览器+脚本宿主`

* '''color'''：（可选）网页使用的配色，要求是用逗号分隔的五个`#rrggbb`颜色

=== 浏览器与脚本宿主 ===

脚本可以识别并显示的浏览器名称和脚本宿主名称包括：

* firefox

** greasemonkey

** tampermonkey

** violentmonkey

* opera

** tampermonkey

** violentmonkey

* chrome

** tampermonkey

** violentmonkey

* safari

** javascriptblocker

** tampermonkey