Skip to content

Commit c6b83cf

Browse files
committed
Docs command with npx. Link to github from docs main page.
1 parent 3863318 commit c6b83cf

8 files changed

Lines changed: 14 additions & 8 deletions

File tree

Docs-README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,7 @@ Left side bar lists the four BlockLike.js entities:
2020
Under each entity is an alphabetically ordered list of all their methods.
2121

2222
There are examples for each.
23+
24+
## Source code
25+
26+
Blocklike is open sourced and MIT licensed. See https://github.com/ronilan/BlockLike.

docs/Backdrop.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1295,7 +1295,7 @@ <h5>Example</h5>
12951295
<br class="clear">
12961296

12971297
<footer>
1298-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Thu Jun 10 2021 21:31:05 GMT-0700 (Pacific Daylight Time) using the Minami theme.
1298+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sat Jun 12 2021 14:49:58 GMT-0700 (Pacific Daylight Time) using the Minami theme.
12991299
</footer>
13001300

13011301
<script>prettyPrint();</script>

docs/Costume.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1730,7 +1730,7 @@ <h5>Example</h5>
17301730
<br class="clear">
17311731

17321732
<footer>
1733-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Thu Jun 10 2021 21:31:05 GMT-0700 (Pacific Daylight Time) using the Minami theme.
1733+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sat Jun 12 2021 14:49:58 GMT-0700 (Pacific Daylight Time) using the Minami theme.
17341734
</footer>
17351735

17361736
<script>prettyPrint();</script>

docs/Sprite.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10310,7 +10310,7 @@ <h5>Example</h5>
1031010310
<br class="clear">
1031110311

1031210312
<footer>
10313-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Thu Jun 10 2021 21:31:05 GMT-0700 (Pacific Daylight Time) using the Minami theme.
10313+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sat Jun 12 2021 14:49:58 GMT-0700 (Pacific Daylight Time) using the Minami theme.
1031410314
</footer>
1031510315

1031610316
<script>prettyPrint();</script>

docs/Stage.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5504,7 +5504,7 @@ <h5>Example</h5>
55045504
<br class="clear">
55055505

55065506
<footer>
5507-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Thu Jun 10 2021 21:31:05 GMT-0700 (Pacific Daylight Time) using the Minami theme.
5507+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sat Jun 12 2021 14:49:58 GMT-0700 (Pacific Daylight Time) using the Minami theme.
55085508
</footer>
55095509

55105510
<script>prettyPrint();</script>

docs/blocklike-1.0.3.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4308,7 +4308,7 @@ <h1 class="page-title">blocklike-1.0.3.js</h1>
43084308
<br class="clear">
43094309

43104310
<footer>
4311-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Thu Jun 10 2021 21:31:05 GMT-0700 (Pacific Daylight Time) using the Minami theme.
4311+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sat Jun 12 2021 14:49:58 GMT-0700 (Pacific Daylight Time) using the Minami theme.
43124312
</footer>
43134313

43144314
<script>prettyPrint();</script>

docs/index.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,9 @@ <h2>Using the docs</h2>
6262
<li>Costume</li>
6363
</ul>
6464
<p>Under each entity is an alphabetically ordered list of all their methods.</p>
65-
<p>There are examples for each.</p></article>
65+
<p>There are examples for each.</p>
66+
<h2>Source code</h2>
67+
<p>Blocklike is open sourced and MIT licensed. See https://github.com/ronilan/BlockLike.</p></article>
6668
</section>
6769

6870

@@ -75,7 +77,7 @@ <h2>Using the docs</h2>
7577
<br class="clear">
7678

7779
<footer>
78-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Thu Jun 10 2021 21:31:05 GMT-0700 (Pacific Daylight Time) using the Minami theme.
80+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sat Jun 12 2021 14:49:58 GMT-0700 (Pacific Daylight Time) using the Minami theme.
7981
</footer>
8082

8183
<script>prettyPrint();</script>

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"test": "webpack --progress --config webpack.config.test.js && mocha --require test/setup.js --exit test/~~out.js && rm test/~~out.js",
1515
"full": "webpack --progress --config webpack.config.js",
1616
"mini": "webpack --progress --config webpack.config-mini.js && node scripts/mini.js",
17-
"docs": "./node_modules/.bin/jsdoc dist/blocklike-*.*.*.js --destination ./docs --template node_modules/minami --readme Docs-README.md",
17+
"docs": "npx jsdoc dist/blocklike-*.*.*.js --destination ./docs --template node_modules/minami --readme Docs-README.md",
1818
"build": "npm run test && npm run full && npm run mini && npm run docs",
1919
"version": "node scripts/version.js & npm run build && git add ."
2020
},

0 commit comments

Comments
 (0)