Skip to content

Commit

Permalink
docs:
Browse files Browse the repository at this point in the history 
使用gh-pages发布文档
  • Loading branch information
landluck authored and landluck committed Jan 19, 2020
1 parent 36b8d63 commit 127dbb4
Show file tree
Hide file tree
Showing 9 changed files with 45 additions and 33 deletions.
16 changes: 8 additions & 8 deletions docs/classes/eventbus.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1016,7 +1016,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> events</h3>
<div class="tsd-signature tsd-kind-icon">events<span class="tsd-signature-symbol">:</span> <a href="../interfaces/event.html" class="tsd-signature-type">Event</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> =&nbsp;[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/EventBus.ts#L9">EventBus.ts:9</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/EventBus.ts#L9">EventBus.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -1038,7 +1038,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> add<wbr>Event</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/EventBus.ts#L123">EventBus.ts:123</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/EventBus.ts#L123">EventBus.ts:123</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1074,7 +1074,7 @@ <h3>clear</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L12">types/index.ts:12</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L12">types/index.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="eventbus.html" class="tsd-signature-type">EventBus</a></h4>
Expand All @@ -1091,7 +1091,7 @@ <h3>emit</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L8">types/index.ts:8</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L8">types/index.ts:8</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1133,7 +1133,7 @@ <h3>find</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L10">types/index.ts:10</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L10">types/index.ts:10</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1168,7 +1168,7 @@ <h3>on</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L2">types/index.ts:2</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L2">types/index.ts:2</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1210,7 +1210,7 @@ <h3>once</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L4">types/index.ts:4</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L4">types/index.ts:4</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1252,7 +1252,7 @@ <h3>remove</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L6">types/index.ts:6</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L6">types/index.ts:6</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
4 changes: 2 additions & 2 deletions docs/enums/eventtypeenum.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -970,7 +970,7 @@ <h3>NORMAL_<wbr>EVENT</h3>
<div class="tsd-signature tsd-kind-icon">NORMAL_<wbr>EVENT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;1</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/enum.ts#L3">enum.ts:3</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/enum.ts#L3">enum.ts:3</a></li>
</ul>
</aside>
</section>
Expand All @@ -980,7 +980,7 @@ <h3>ONCE_<wbr>EVENT</h3>
<div class="tsd-signature tsd-kind-icon">ONCE_<wbr>EVENT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/enum.ts#L5">enum.ts:5</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/enum.ts#L5">enum.ts:5</a></li>
</ul>
</aside>
</section>
Expand Down
13 changes: 9 additions & 4 deletions docs/globals.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1014,6 +1014,11 @@ <h2 id="-">基本使用方法</h2>
onClick () {
bus.emit(<span class="hljs-string">'事件名'</span>, a, b, c)
}

<span class="hljs-comment">// 清空所有事件监听</span>
onClear () {
bus.clear()
}
</code></pre>
<ol start="2">
<li><p>是否可以在 <code>Vue</code> 中使用呢</p>
Expand Down Expand Up @@ -1080,7 +1085,7 @@ <h3>Event<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L21">types/index.ts:21</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L21">types/index.ts:21</a></li>
</ul>
</aside>
</section>
Expand All @@ -1093,7 +1098,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> bus</h3>
<div class="tsd-signature tsd-kind-icon">bus<span class="tsd-signature-symbol">:</span> <a href="interfaces/eventbusinstance.html" class="tsd-signature-type">EventBusInstance</a><span class="tsd-signature-symbol"> =&nbsp;createInstance()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/bus.ts#L11">bus.ts:11</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/bus.ts#L11">bus.ts:11</a></li>
</ul>
</aside>
</section>
Expand All @@ -1110,7 +1115,7 @@ <h3>create<wbr>Instance</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/bus.ts#L5">bus.ts:5</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/bus.ts#L5">bus.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="interfaces/eventbusinstance.html" class="tsd-signature-type">EventBusInstance</a></h4>
Expand All @@ -1127,7 +1132,7 @@ <h3>create<wbr>Uid</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/utils.ts#L5">utils.ts:5</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/utils.ts#L5">utils.ts:5</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
13 changes: 9 additions & 4 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1014,6 +1014,11 @@ <h2 id="-">基本使用方法</h2>
onClick () {
bus.emit(<span class="hljs-string">'事件名'</span>, a, b, c)
}

<span class="hljs-comment">// 清空所有事件监听</span>
onClear () {
bus.clear()
}
</code></pre>
<ol start="2">
<li><p>是否可以在 <code>Vue</code> 中使用呢</p>
Expand Down Expand Up @@ -1081,7 +1086,7 @@ <h3>Event<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L21">types/index.ts:21</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L21">types/index.ts:21</a></li>
</ul>
</aside>
</section>
Expand All @@ -1094,7 +1099,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> bus</h3>
<div class="tsd-signature tsd-kind-icon">bus<span class="tsd-signature-symbol">:</span> <a href="interfaces/eventbusinstance.html" class="tsd-signature-type">EventBusInstance</a><span class="tsd-signature-symbol"> =&nbsp;createInstance()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/bus.ts#L11">bus.ts:11</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/bus.ts#L11">bus.ts:11</a></li>
</ul>
</aside>
</section>
Expand All @@ -1111,7 +1116,7 @@ <h3>create<wbr>Instance</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/bus.ts#L5">bus.ts:5</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/bus.ts#L5">bus.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="interfaces/eventbusinstance.html" class="tsd-signature-type">EventBusInstance</a></h4>
Expand All @@ -1128,7 +1133,7 @@ <h3>create<wbr>Uid</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/utils.ts#L5">utils.ts:5</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/utils.ts#L5">utils.ts:5</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/event.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -978,7 +978,7 @@ <h3>executes</h3>
<div class="tsd-signature tsd-kind-icon">executes<span class="tsd-signature-symbol">:</span> <a href="execute.html" class="tsd-signature-type">Execute</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L25">types/index.ts:25</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L25">types/index.ts:25</a></li>
</ul>
</aside>
</section>
Expand All @@ -988,7 +988,7 @@ <h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L24">types/index.ts:24</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L24">types/index.ts:24</a></li>
</ul>
</aside>
</section>
Expand Down
14 changes: 7 additions & 7 deletions docs/interfaces/eventbusinstance.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1012,7 +1012,7 @@ <h3>clear</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/eventbus.html">EventBus</a>.<a href="../classes/eventbus.html#clear">clear</a></p>
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L12">types/index.ts:12</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L12">types/index.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../classes/eventbus.html" class="tsd-signature-type">EventBus</a></h4>
Expand All @@ -1029,7 +1029,7 @@ <h3>create</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L18">types/index.ts:18</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L18">types/index.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../classes/eventbus.html" class="tsd-signature-type">EventBus</a></h4>
Expand All @@ -1047,7 +1047,7 @@ <h3>emit</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/eventbus.html">EventBus</a>.<a href="../classes/eventbus.html#emit">emit</a></p>
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L8">types/index.ts:8</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L8">types/index.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -1074,7 +1074,7 @@ <h3>find</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/eventbus.html">EventBus</a>.<a href="../classes/eventbus.html#find">find</a></p>
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L10">types/index.ts:10</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L10">types/index.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -1101,7 +1101,7 @@ <h3>on</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/eventbus.html">EventBus</a>.<a href="../classes/eventbus.html#on">on</a></p>
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L2">types/index.ts:2</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L2">types/index.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -1128,7 +1128,7 @@ <h3>once</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/eventbus.html">EventBus</a>.<a href="../classes/eventbus.html#once">once</a></p>
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L4">types/index.ts:4</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L4">types/index.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -1155,7 +1155,7 @@ <h3>remove</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/eventbus.html">EventBus</a>.<a href="../classes/eventbus.html#remove">remove</a></p>
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L6">types/index.ts:6</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L6">types/index.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/execute.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -982,7 +982,7 @@ <h3>event<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">event<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="../globals.html#eventtype" class="tsd-signature-type">EventType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L30">types/index.ts:30</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L30">types/index.ts:30</a></li>
</ul>
</aside>
</section>
Expand All @@ -992,7 +992,7 @@ <h3>execute</h3>
<div class="tsd-signature tsd-kind-icon">execute<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L31">types/index.ts:31</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L31">types/index.ts:31</a></li>
</ul>
</aside>
</section>
Expand All @@ -1002,7 +1002,7 @@ <h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/51916c5/src/types/index.ts#L29">types/index.ts:29</a></li>
<li>Defined in <a href="https://github.com/landluck/iny-bus/blob/36b8d63/src/types/index.ts#L29">types/index.ts:29</a></li>
</ul>
</aside>
</section>
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"test:watch": "jest --coverage --watch",
"test:prod": "npm run lint && npm run test -- --no-cache",
"docs": "typedoc --out docs --target es6 --theme minimal --mode file src",
"deploy-docs": "gh-pages -d docs --add",
"deploy-docs": "gh-pages -d docs --add --git /usr/bin/git",
"report-coverage": "codecov ./coverage/clover.xml",
"commit": "git-cz",
"semantic-release": "semantic-release",
Expand Down
6 changes: 4 additions & 2 deletions release-docs.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ if [[ $REPLY =~ ^[Yy]$ ]]
then
echo "beigin Releasing docs"

rm -rf docs/dist
rm -rf docs

npm run docs

npm run deploy-docs
gh-pages-clean

gh-pages -d docs --add --git /usr/bin/git
fi

0 comments on commit 127dbb4

Please sign in to comment.