Skip to content

Commit 7aadb44

Browse files
committed
building docs
1 parent 4f438d6 commit 7aadb44

File tree

10 files changed

+31
-27
lines changed

10 files changed

+31
-27
lines changed

docs/cn/index.html

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<title>简介 · AnyProxy</title>
88
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
99
<meta name="description" content="">
10-
<meta name="generator" content="GitBook 3.2.3">
10+
<meta name="generator" content="GitBook 3.2.2">
1111
<meta name="author" content="AnyProxy">
1212

1313

@@ -809,11 +809,11 @@ <h2 id="&#x4F5C;&#x4E3A;npm&#x6A21;&#x5757;&#x4F7F;&#x7528;">&#x4F5C;&#x4E3A;npm
809809
rule: <span class="hljs-built_in">require</span>(<span class="hljs-string">&apos;myRuleModule&apos;</span>),
810810
webInterface: {
811811
enable: <span class="hljs-literal">true</span>,
812-
webPort: <span class="hljs-number">8002</span>,
813-
wsPort: <span class="hljs-number">8003</span>,
812+
webPort: <span class="hljs-number">8002</span>
814813
},
815814
throttle: <span class="hljs-number">10000</span>,
816815
forceProxyHttps: <span class="hljs-literal">false</span>,
816+
wsIntercept: <span class="hljs-literal">false</span>, <span class="hljs-comment">// &#x4E0D;&#x5F00;&#x542F;websocket&#x4EE3;&#x7406;</span>
817817
silent: <span class="hljs-literal">false</span>
818818
};
819819
<span class="hljs-keyword">const</span> proxyServer = <span class="hljs-keyword">new</span> AnyProxy.ProxyServer(options);
@@ -840,6 +840,7 @@ <h2 id="&#x4F5C;&#x4E3A;npm&#x6A21;&#x5757;&#x4F7F;&#x7528;">&#x4F5C;&#x4E3A;npm
840840
<li><code>forceProxyHttps</code> {boolean} &#x662F;&#x5426;&#x5F3A;&#x5236;&#x62E6;&#x622A;&#x6240;&#x6709;&#x7684;https&#xFF0C;&#x5FFD;&#x7565;&#x89C4;&#x5219;&#x6A21;&#x5757;&#x7684;&#x8FD4;&#x56DE;&#xFF0C;&#x9ED8;&#x8BA4;<code>false</code></li>
841841
<li><code>silent</code> {boolean} &#x662F;&#x5426;&#x5C4F;&#x853D;&#x6240;&#x6709;console&#x8F93;&#x51FA;&#xFF0C;&#x9ED8;&#x8BA4;<code>false</code></li>
842842
<li><code>dangerouslyIgnoreUnauthorized</code> {boolean} &#x662F;&#x5426;&#x5FFD;&#x7565;&#x8BF7;&#x6C42;&#x4E2D;&#x7684;&#x8BC1;&#x4E66;&#x9519;&#x8BEF;&#xFF0C;&#x9ED8;&#x8BA4;<code>false</code></li>
843+
<li><code>wsIntercept</code> {boolean} &#x662F;&#x5426;&#x5F00;&#x542F;websocket&#x4EE3;&#x7406;&#xFF0C;&#x9ED8;&#x8BA4;<code>false</code></li>
843844
<li><code>webInterface</code> {object} web&#x7248;&#x754C;&#x9762;&#x914D;&#x7F6E;<ul>
844845
<li><code>enable</code> {boolean} &#x662F;&#x5426;&#x542F;&#x7528;web&#x7248;&#x754C;&#x9762;&#xFF0C;&#x9ED8;&#x8BA4;<code>false</code></li>
845846
<li><code>webPort</code> {number} web&#x7248;&#x754C;&#x9762;&#x7AEF;&#x53E3;&#x53F7;&#xFF0C;&#x9ED8;&#x8BA4;<code>8002</code></li>
@@ -1635,7 +1636,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
16351636
<script>
16361637
var gitbook = gitbook || [];
16371638
gitbook.push(function() {
1638-
gitbook.page.hasChanged({"page":{"title":"简介","level":"1.1","depth":1,"next":{"title":"快速开始","level":"1.2","depth":1,"anchor":"#快速开始","path":"README.md","ref":"README.md#快速开始","articles":[{"title":"安装","level":"1.2.1","depth":2,"anchor":"#安装","path":"README.md","ref":"README.md#安装","articles":[]},{"title":"启动","level":"1.2.2","depth":2,"anchor":"#启动","path":"README.md","ref":"README.md#启动","articles":[]},{"title":"其他命令","level":"1.2.3","depth":2,"anchor":"#其他命令","path":"README.md","ref":"README.md#其他命令","articles":[]},{"title":"作为npm模块启动","level":"1.2.4","depth":2,"anchor":"#作为npm模块使用","path":"README.md","ref":"README.md#作为npm模块使用","articles":[]}]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","author":"AnyProxy","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"AnyProxy","language":"cn","gitbook":"*","description":"A fully configurable http/https proxy in NodeJS"},"file":{"path":"README.md","mtime":"2018-01-03T15:10:19.584Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-01-03T15:10:20.722Z"},"basePath":".","book":{"language":"cn"}});
1639+
gitbook.page.hasChanged({"page":{"title":"简介","level":"1.1","depth":1,"next":{"title":"快速开始","level":"1.2","depth":1,"anchor":"#快速开始","path":"README.md","ref":"README.md#快速开始","articles":[{"title":"安装","level":"1.2.1","depth":2,"anchor":"#安装","path":"README.md","ref":"README.md#安装","articles":[]},{"title":"启动","level":"1.2.2","depth":2,"anchor":"#启动","path":"README.md","ref":"README.md#启动","articles":[]},{"title":"其他命令","level":"1.2.3","depth":2,"anchor":"#其他命令","path":"README.md","ref":"README.md#其他命令","articles":[]},{"title":"作为npm模块启动","level":"1.2.4","depth":2,"anchor":"#作为npm模块使用","path":"README.md","ref":"README.md#作为npm模块使用","articles":[]}]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","author":"AnyProxy","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"AnyProxy","language":"cn","gitbook":"*","description":"A fully configurable http/https proxy in NodeJS"},"file":{"path":"README.md","mtime":"2018-02-05T02:16:34.020Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2018-02-05T02:16:35.891Z"},"basePath":".","book":{"language":"cn"}});
16391640
});
16401641
</script>
16411642
</div>

docs/cn/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/cn/src_doc.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,11 @@ const options = {
7979
rule: require('myRuleModule'),
8080
webInterface: {
8181
enable: true,
82-
webPort: 8002,
83-
wsPort: 8003,
82+
webPort: 8002
8483
},
8584
throttle: 10000,
8685
forceProxyHttps: false,
86+
wsIntercept: false, // 不开启websocket代理
8787
silent: false
8888
};
8989
const proxyServer = new AnyProxy.ProxyServer(options);
@@ -110,6 +110,7 @@ proxyServer.close();
110110
* `forceProxyHttps` {boolean} 是否强制拦截所有的https,忽略规则模块的返回,默认`false`
111111
* `silent` {boolean} 是否屏蔽所有console输出,默认`false`
112112
* `dangerouslyIgnoreUnauthorized` {boolean} 是否忽略请求中的证书错误,默认`false`
113+
* `wsIntercept` {boolean} 是否开启websocket代理,默认`false`
113114
* `webInterface` {object} web版界面配置
114115
* `enable` {boolean} 是否启用web版界面,默认`false`
115116
* `webPort` {number} web版界面端口号,默认`8002`

docs/en/index.html

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<title>Introduction · AnyProxy</title>
88
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
99
<meta name="description" content="">
10-
<meta name="generator" content="GitBook 3.2.3">
10+
<meta name="generator" content="GitBook 3.2.2">
1111
<meta name="author" content="AnyProxy">
1212

1313

@@ -795,11 +795,11 @@ <h3 id="use-anyproxy-as-an-npm-module">Use AnyProxy as an npm module</h3>
795795
rule: <span class="hljs-built_in">require</span>(<span class="hljs-string">&apos;myRuleModule&apos;</span>),
796796
webInterface: {
797797
enable: <span class="hljs-literal">true</span>,
798-
webPort: <span class="hljs-number">8002</span>,
799-
wsPort: <span class="hljs-number">8003</span>,
798+
webPort: <span class="hljs-number">8002</span>
800799
},
801800
throttle: <span class="hljs-number">10000</span>,
802801
forceProxyHttps: <span class="hljs-literal">false</span>,
802+
wsIntercept: <span class="hljs-literal">false</span>,
803803
silent: <span class="hljs-literal">false</span>
804804
};
805805
<span class="hljs-keyword">const</span> proxyServer = <span class="hljs-keyword">new</span> AnyProxy.ProxyServer(options);
@@ -823,11 +823,12 @@ <h3 id="use-anyproxy-as-an-npm-module">Use AnyProxy as an npm module</h3>
823823
<li><code>port</code> {number} required, port number of proxy server</li>
824824
<li><code>rule</code> {object} your rule module</li>
825825
<li><code>throttle</code> {number} throttle in kb/s, unlimited for default</li>
826-
<li><code>forceProxyHttps</code> {boolean} in force intercept all https request, false for default</li>
827-
<li><code>silent</code> {boolean} if keep silent in console, false for default<code>false</code></li>
828-
<li><code>dangerouslyIgnoreUnauthorized</code> {boolean} if ignore certificate error in request, false for default</li>
826+
<li><code>forceProxyHttps</code> {boolean} in force intercept all https request, default to <code>false</code></li>
827+
<li><code>silent</code> {boolean} if keep silent in console, false for default <code>false</code></li>
828+
<li><code>dangerouslyIgnoreUnauthorized</code> {boolean} if ignore certificate error in request, default to <code>false</code></li>
829+
<li><code>wsIntercept</code> {boolean} whether to intercept websocket, default to <code>false</code></li>
829830
<li><code>webInterface</code> {object} config for web interface<ul>
830-
<li><code>enable</code> {boolean} if enable web interface, false for default</li>
831+
<li><code>enable</code> {boolean} if enable web interface, default to <code>false</code></li>
831832
<li><code>webPort</code> {number} port number for web interface</li>
832833
</ul>
833834
</li>
@@ -1623,7 +1624,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
16231624
<script>
16241625
var gitbook = gitbook || [];
16251626
gitbook.push(function() {
1626-
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"Getting-Start","level":"1.2","depth":1,"anchor":"#getting-start","path":"README.md","ref":"README.md#getting-start","articles":[{"title":"Install","level":"1.2.1","depth":2,"anchor":"#install","path":"README.md","ref":"README.md#install","articles":[]},{"title":"Launch","level":"1.2.2","depth":2,"anchor":"#launch","path":"README.md","ref":"README.md#launch","articles":[]},{"title":"Options","level":"1.2.3","depth":2,"anchor":"#options","path":"README.md","ref":"README.md#options","articles":[]},{"title":"As Node Module","level":"1.2.4","depth":2,"anchor":"#use-anyproxy-as-an-npm-module","path":"README.md","ref":"README.md#use-anyproxy-as-an-npm-module","articles":[]}]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","author":"AnyProxy","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"AnyProxy","language":"en","gitbook":"*","description":"A fully configurable http/https proxy in NodeJS"},"file":{"path":"README.md","mtime":"2018-01-03T15:10:19.585Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-01-03T15:10:20.722Z"},"basePath":".","book":{"language":"en"}});
1627+
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"Getting-Start","level":"1.2","depth":1,"anchor":"#getting-start","path":"README.md","ref":"README.md#getting-start","articles":[{"title":"Install","level":"1.2.1","depth":2,"anchor":"#install","path":"README.md","ref":"README.md#install","articles":[]},{"title":"Launch","level":"1.2.2","depth":2,"anchor":"#launch","path":"README.md","ref":"README.md#launch","articles":[]},{"title":"Options","level":"1.2.3","depth":2,"anchor":"#options","path":"README.md","ref":"README.md#options","articles":[]},{"title":"As Node Module","level":"1.2.4","depth":2,"anchor":"#use-anyproxy-as-an-npm-module","path":"README.md","ref":"README.md#use-anyproxy-as-an-npm-module","articles":[]}]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","author":"AnyProxy","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"AnyProxy","language":"en","gitbook":"*","description":"A fully configurable http/https proxy in NodeJS"},"file":{"path":"README.md","mtime":"2018-02-05T02:16:34.020Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2018-02-05T02:16:35.891Z"},"basePath":".","book":{"language":"en"}});
16271628
});
16281629
</script>
16291630
</div>

docs/en/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/en/src_doc.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,11 @@ const options = {
7878
rule: require('myRuleModule'),
7979
webInterface: {
8080
enable: true,
81-
webPort: 8002,
82-
wsPort: 8003,
81+
webPort: 8002
8382
},
8483
throttle: 10000,
8584
forceProxyHttps: false,
85+
wsIntercept: false,
8686
silent: false
8787
};
8888
const proxyServer = new AnyProxy.ProxyServer(options);
@@ -106,11 +106,12 @@ proxyServer.close();
106106
* `port` {number} required, port number of proxy server
107107
* `rule` {object} your rule module
108108
* `throttle` {number} throttle in kb/s, unlimited for default
109-
* `forceProxyHttps` {boolean} in force intercept all https request, false for default
110-
* `silent` {boolean} if keep silent in console, false for default`false`
111-
* `dangerouslyIgnoreUnauthorized` {boolean} if ignore certificate error in request, false for default
109+
* `forceProxyHttps` {boolean} in force intercept all https request, default to `false`
110+
* `silent` {boolean} if keep silent in console, false for default `false`
111+
* `dangerouslyIgnoreUnauthorized` {boolean} if ignore certificate error in request, default to `false`
112+
* `wsIntercept` {boolean} whether to intercept websocket, default to `false`
112113
* `webInterface` {object} config for web interface
113-
* `enable` {boolean} if enable web interface, false for default
114+
* `enable` {boolean} if enable web interface, default to `false`
114115
* `webPort` {number} port number for web interface
115116
* Event: `ready`
116117
* emit when proxy server is ready

docs/gitbook/gitbook.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/gitbook/theme.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<title>Choose a language · AnyProxy</title>
88
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
99
<meta name="description" content="">
10-
<meta name="generator" content="GitBook 3.2.3">
10+
<meta name="generator" content="GitBook 3.2.2">
1111
<meta name="author" content="AnyProxy">
1212

1313

docs/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)