Skip to content

Commit cebd951

Browse files
helderbertohelderberto
authored
Merge pull request #29 from codevor/fix/generate-docs
docs: generate in root docs folder
2 parents 42f63d9 + 710f8df commit cebd951

30 files changed

+163
-2752
lines changed

‎.jsdocrc‎

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@
44
"dictionaries": ["jsdoc"]
55
},
66
"source": {
7-
"include": ["src", "package.json", "README.md"],
8-
"includePattern": ".js$",
9-
"excludePattern": "(node_modules/|docs)"
7+
"include": ["src/", "./README.md"]
108
},
119
"plugins": ["plugins/markdown"],
1210
"templates": {
@@ -19,6 +17,30 @@
1917
"destination": "./docs/",
2018
"encoding": "utf8",
2119
"private": true,
22-
"recurse": true
20+
"recurse": true,
21+
"verbose": true
22+
},
23+
"docdash": {
24+
"static": true,
25+
"sort": true,
26+
"disqus": "",
27+
"meta": {
28+
"title": "js-http-status",
29+
"description": "A simple way to catch HTTP statuses with JavaScript..",
30+
"keyword": "jsdoc, docdash"
31+
},
32+
"search": true,
33+
"collapse": true,
34+
"typedefs": true,
35+
"removeQuotes": "none",
36+
"scripts": [],
37+
"menu": {
38+
"Github repo": {
39+
"href": "https://github.com/codevor/js-http-status",
40+
"target": "_blank",
41+
"class": "menu-item",
42+
"id": "repository"
43+
}
44+
}
2345
}
2446
}

‎docs/index.html‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@
33
<head>
44

55
<meta charset="utf-8">
6-
<title>Home - Documentation</title>
6+
<title>Home - js-http-status</title>
7+
8+
<meta name="description" content="A simple way to catch HTTP statuses with JavaScript.." />
9+
10+
<meta name="keywords" content="jsdoc, docdash" />
11+
<meta name="keyword" content="jsdoc, docdash" />
12+
713

814

915
<script src="scripts/prettify/prettify.js"></script>
@@ -27,7 +33,9 @@
2733

2834
<nav >
2935

30-
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-isCreated.html">isCreated</a></li><li><a href="module-isMovedPermanently.html">isMovedPermanently</a></li><li><a href="module-isOk.html">isOk</a></li><li><a href="module-isUnauthorized.html">isUnauthorized</a></li></ul>
36+
<input type="text" id="nav-search" placeholder="Search" />
37+
38+
<h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/codevor/js-http-status" target="_blank" class="menu-item" id="repository" >Github repo</a></h2><h3>Modules</h3><ul><li><a href="module-isCreated.html">isCreated</a></li><li><a href="module-isMovedPermanently.html">isMovedPermanently</a></li><li><a href="module-isOk.html">isOk</a></li><li><a href="module-isUnauthorized.html">isUnauthorized</a></li></ul>
3139
</nav>
3240

3341
<div id="main">
@@ -41,7 +49,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-is
4149

4250

4351
<section class="package">
44-
<h3>js-http-status 0.1.0</h3>
52+
<h3> </h3>
4553
</section>
4654

4755

@@ -111,13 +119,17 @@ <h2>License</h2>
111119
<br class="clear">
112120

113121
<footer>
114-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
122+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Mon Oct 21 2019 08:43:27 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
115123
</footer>
116124

117125
<script>prettyPrint();</script>
118126
<script src="scripts/polyfill.js"></script>
119127
<script src="scripts/linenumber.js"></script>
120128

129+
<script src="scripts/search.js" defer></script>
130+
131+
132+
<script src="scripts/collapse.js" defer></script>
121133

122134

123135
</body>

‎docs/is-created.js.html‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@
33
<head>
44

55
<meta charset="utf-8">
6-
<title>is-created.js - Documentation</title>
6+
<title>is-created.js - js-http-status</title>
7+
8+
<meta name="description" content="A simple way to catch HTTP statuses with JavaScript.." />
9+
10+
<meta name="keywords" content="jsdoc, docdash" />
11+
<meta name="keyword" content="jsdoc, docdash" />
12+
713

814

915
<script src="scripts/prettify/prettify.js"></script>
@@ -27,7 +33,9 @@
2733

2834
<nav >
2935

30-
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-isCreated.html">isCreated</a></li><li><a href="module-isMovedPermanently.html">isMovedPermanently</a></li><li><a href="module-isOk.html">isOk</a></li><li><a href="module-isUnauthorized.html">isUnauthorized</a></li></ul>
36+
<input type="text" id="nav-search" placeholder="Search" />
37+
38+
<h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/codevor/js-http-status" target="_blank" class="menu-item" id="repository" >Github repo</a></h2><h3>Modules</h3><ul><li><a href="module-isCreated.html">isCreated</a></li><li><a href="module-isMovedPermanently.html">isMovedPermanently</a></li><li><a href="module-isOk.html">isOk</a></li><li><a href="module-isUnauthorized.html">isUnauthorized</a></li></ul>
3139
</nav>
3240

3341
<div id="main">
@@ -72,13 +80,17 @@ <h1 class="page-title">is-created.js</h1>
7280
<br class="clear">
7381

7482
<footer>
75-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
83+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Mon Oct 21 2019 08:43:27 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
7684
</footer>
7785

7886
<script>prettyPrint();</script>
7987
<script src="scripts/polyfill.js"></script>
8088
<script src="scripts/linenumber.js"></script>
8189

90+
<script src="scripts/search.js" defer></script>
91+
92+
93+
<script src="scripts/collapse.js" defer></script>
8294

8395

8496
</body>

‎docs/is-moved-permanently.js.html‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@
33
<head>
44

55
<meta charset="utf-8">
6-
<title>is-moved-permanently.js - Documentation</title>
6+
<title>is-moved-permanently.js - js-http-status</title>
7+
8+
<meta name="description" content="A simple way to catch HTTP statuses with JavaScript.." />
9+
10+
<meta name="keywords" content="jsdoc, docdash" />
11+
<meta name="keyword" content="jsdoc, docdash" />
12+
713

814

915
<script src="scripts/prettify/prettify.js"></script>
@@ -27,7 +33,9 @@
2733

2834
<nav >
2935

30-
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-isCreated.html">isCreated</a></li><li><a href="module-isMovedPermanently.html">isMovedPermanently</a></li><li><a href="module-isOk.html">isOk</a></li><li><a href="module-isUnauthorized.html">isUnauthorized</a></li></ul>
36+
<input type="text" id="nav-search" placeholder="Search" />
37+
38+
<h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/codevor/js-http-status" target="_blank" class="menu-item" id="repository" >Github repo</a></h2><h3>Modules</h3><ul><li><a href="module-isCreated.html">isCreated</a></li><li><a href="module-isMovedPermanently.html">isMovedPermanently</a></li><li><a href="module-isOk.html">isOk</a></li><li><a href="module-isUnauthorized.html">isUnauthorized</a></li></ul>
3139
</nav>
3240

3341
<div id="main">
@@ -72,13 +80,17 @@ <h1 class="page-title">is-moved-permanently.js</h1>
7280
<br class="clear">
7381

7482
<footer>
75-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
83+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Mon Oct 21 2019 08:43:27 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
7684
</footer>
7785

7886
<script>prettyPrint();</script>
7987
<script src="scripts/polyfill.js"></script>
8088
<script src="scripts/linenumber.js"></script>
8189

90+
<script src="scripts/search.js" defer></script>
91+
92+
93+
<script src="scripts/collapse.js" defer></script>
8294

8395

8496
</body>

‎docs/is-ok.js.html‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@
33
<head>
44

55
<meta charset="utf-8">
6-
<title>is-ok.js - Documentation</title>
6+
<title>is-ok.js - js-http-status</title>
7+
8+
<meta name="description" content="A simple way to catch HTTP statuses with JavaScript.." />
9+
10+
<meta name="keywords" content="jsdoc, docdash" />
11+
<meta name="keyword" content="jsdoc, docdash" />
12+
713

814

915
<script src="scripts/prettify/prettify.js"></script>
@@ -27,7 +33,9 @@
2733

2834
<nav >
2935

30-
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-isCreated.html">isCreated</a></li><li><a href="module-isMovedPermanently.html">isMovedPermanently</a></li><li><a href="module-isOk.html">isOk</a></li><li><a href="module-isUnauthorized.html">isUnauthorized</a></li></ul>
36+
<input type="text" id="nav-search" placeholder="Search" />
37+
38+
<h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/codevor/js-http-status" target="_blank" class="menu-item" id="repository" >Github repo</a></h2><h3>Modules</h3><ul><li><a href="module-isCreated.html">isCreated</a></li><li><a href="module-isMovedPermanently.html">isMovedPermanently</a></li><li><a href="module-isOk.html">isOk</a></li><li><a href="module-isUnauthorized.html">isUnauthorized</a></li></ul>
3139
</nav>
3240

3341
<div id="main">
@@ -72,13 +80,17 @@ <h1 class="page-title">is-ok.js</h1>
7280
<br class="clear">
7381

7482
<footer>
75-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
83+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Mon Oct 21 2019 08:43:27 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
7684
</footer>
7785

7886
<script>prettyPrint();</script>
7987
<script src="scripts/polyfill.js"></script>
8088
<script src="scripts/linenumber.js"></script>
8189

90+
<script src="scripts/search.js" defer></script>
91+
92+
93+
<script src="scripts/collapse.js" defer></script>
8294

8395

8496
</body>

‎docs/is-unauthorized.js.html‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@
33
<head>
44

55
<meta charset="utf-8">
6-
<title>is-unauthorized.js - Documentation</title>
6+
<title>is-unauthorized.js - js-http-status</title>
7+
8+
<meta name="description" content="A simple way to catch HTTP statuses with JavaScript.." />
9+
10+
<meta name="keywords" content="jsdoc, docdash" />
11+
<meta name="keyword" content="jsdoc, docdash" />
12+
713

814

915
<script src="scripts/prettify/prettify.js"></script>
@@ -27,7 +33,9 @@
2733

2834
<nav >
2935

30-
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-isCreated.html">isCreated</a></li><li><a href="module-isMovedPermanently.html">isMovedPermanently</a></li><li><a href="module-isOk.html">isOk</a></li><li><a href="module-isUnauthorized.html">isUnauthorized</a></li></ul>
36+
<input type="text" id="nav-search" placeholder="Search" />
37+
38+
<h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/codevor/js-http-status" target="_blank" class="menu-item" id="repository" >Github repo</a></h2><h3>Modules</h3><ul><li><a href="module-isCreated.html">isCreated</a></li><li><a href="module-isMovedPermanently.html">isMovedPermanently</a></li><li><a href="module-isOk.html">isOk</a></li><li><a href="module-isUnauthorized.html">isUnauthorized</a></li></ul>
3139
</nav>
3240

3341
<div id="main">
@@ -72,13 +80,17 @@ <h1 class="page-title">is-unauthorized.js</h1>
7280
<br class="clear">
7381

7482
<footer>
75-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun Oct 20 2019 23:05:18 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
83+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Mon Oct 21 2019 08:43:27 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
7684
</footer>
7785

7886
<script>prettyPrint();</script>
7987
<script src="scripts/polyfill.js"></script>
8088
<script src="scripts/linenumber.js"></script>
8189

90+
<script src="scripts/search.js" defer></script>
91+
92+
93+
<script src="scripts/collapse.js" defer></script>
8294

8395

8496
</body>

0 commit comments

Comments
 (0)