Skip to content

Commit c232c9f

Browse files
thealjeythealjey
committed
[changed] host docs on GitHub Pages
1 parent 9cdeb94 commit c232c9f

7 files changed

Lines changed: 53 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# react-bootstrap-combobox
22
*A combo-box component for React Bootstrap.*
33

4+
[Project Home](https://github.com/thealjey/react-bootstrap-combobox)
5+
|
6+
[API Docs](https://thealjey.github.io/react-bootstrap-combobox)
7+
48
[![Build Status](https://travis-ci.org/thealjey/react-bootstrap-combobox.svg?branch=master)](https://travis-ci.org/thealjey/react-bootstrap-combobox)
59
[![Coverage Status](https://coveralls.io/repos/thealjey/react-bootstrap-combobox/badge.svg?branch=master&service=github)](https://coveralls.io/github/thealjey/react-bootstrap-combobox?branch=master)
610
[![Code Climate](https://codeclimate.com/github/thealjey/react-bootstrap-combobox/badges/gpa.svg)](https://codeclimate.com/github/thealjey/react-bootstrap-combobox)
@@ -31,11 +35,6 @@ performance increase from React for free!
3135
npm i react-bootstrap-combobox --save
3236
```
3337

34-
### API Documentation
35-
36-
To get better acquainted with the available tools feel free to skim through the auto-generated
37-
[API Docs](https://rawgit.com/thealjey/react-bootstrap-combobox/master/docs/index.html).
38-
3938
### Usage
4039

4140
You need to include the **"_index.scss"** file from this package.

‎bin/build.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import {JS, NativeProcess, SASSLint} from 'webcompiler';
44
import {join} from 'path';
5+
import {createReadStream, createWriteStream} from 'fs';
56

67
const rootDir = join(__dirname, '..'),
78
binDir = join(rootDir, 'bin'),
@@ -25,6 +26,8 @@ new SASSLint().run([style, devStyle], function () {
2526
if (e) {
2627
return console.error(e);
2728
}
29+
createReadStream(join(rootDir, 'LICENSE')).pipe(createWriteStream(join(docsDir, 'LICENSE')));
30+
createReadStream(join(rootDir, 'doc_readme.md')).pipe(createWriteStream(join(docsDir, 'README.md')));
2831
console.log('\x1b[32mGenerated API documentation!\x1b[0m');
2932
npm.run(Function.prototype, ['test'], {stdio: 'inherit'});
3033
}, [buildDir, '-d', docsDir, '-R', readme, '-c', jsdocConfig]);

‎doc_readme.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# "react-bootstrap-combobox" Documentation Website
2+
*JSDoc generated API documentation site.*
3+
4+
[Project Home](https://github.com/thealjey/react-bootstrap-combobox)
5+
|
6+
[API Docs](https://thealjey.github.io/react-bootstrap-combobox)

‎docs/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2015 Eugene Kuzmenko
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎docs/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# "react-bootstrap-combobox" Documentation Website
2+
*JSDoc generated API documentation site.*
3+
4+
[Project Home](https://github.com/thealjey/react-bootstrap-combobox)
5+
|
6+
[API Docs](https://thealjey.github.io/react-bootstrap-combobox)

‎docs/index.html‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ <h3> </h3>
4444

4545
<section>
4646
<article><h1>react-bootstrap-combobox</h1><p><em>A combo-box component for React Bootstrap.</em></p>
47+
<p><a href="https://github.com/thealjey/react-bootstrap-combobox">Project Home</a>
48+
|
49+
<a href="https://thealjey.github.io/react-bootstrap-combobox">API Docs</a></p>
4750
<p><a href="https://travis-ci.org/thealjey/react-bootstrap-combobox"><img src="https://travis-ci.org/thealjey/react-bootstrap-combobox.svg?branch=master" alt="Build Status"></a>
4851
<a href="https://coveralls.io/github/thealjey/react-bootstrap-combobox?branch=master"><img src="https://coveralls.io/repos/thealjey/react-bootstrap-combobox/badge.svg?branch=master&amp;service=github" alt="Coverage Status"></a>
4952
<a href="https://codeclimate.com/github/thealjey/react-bootstrap-combobox"><img src="https://codeclimate.com/github/thealjey/react-bootstrap-combobox/badges/gpa.svg" alt="Code Climate"></a>
@@ -62,9 +65,7 @@ <h3>Features</h3><ol>
6265
</ol>
6366
<h3>Hint</h3><p>Do not forget to set the <code>NODE_ENV</code> environment variable to <strong>&quot;production&quot;</strong> in production to get some instant
6467
performance increase from React for free!</p>
65-
<h3>Installation</h3><pre class="prettyprint source"><code>npm i react-bootstrap-combobox --save</code></pre><h3>API Documentation</h3><p>To get better acquainted with the available tools feel free to skim through the auto-generated
66-
<a href="https://rawgit.com/thealjey/react-bootstrap-combobox/master/docs/index.html">API Docs</a>.</p>
67-
<h3>Usage</h3><p>You need to include the <strong>&quot;_index.scss&quot;</strong> file from this package.
68+
<h3>Installation</h3><pre class="prettyprint source"><code>npm i react-bootstrap-combobox --save</code></pre><h3>Usage</h3><p>You need to include the <strong>&quot;_index.scss&quot;</strong> file from this package.
6869
If you are using <a href="https://github.com/thealjey/webcompiler">webcompiler</a> then you can simply do:</p>
6970
<pre class="prettyprint source lang-SCSS"><code>// import Bootstrap
7071
@import &quot;bootstrap&quot;;

‎package.json‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,20 @@
88
"lint": "eslint ./",
99
"build": "babel-node bin/build",
1010
"start": "babel-node bin/server",
11-
"release": "release"
11+
"release": "release",
12+
"postpublish": "git push origin `git subtree split --prefix docs master`:gh-pages --force"
1213
},
1314
"repository": {
1415
"type": "git",
1516
"url": "git+https://github.com/thealjey/react-bootstrap-combobox.git"
1617
},
18+
"files": [
19+
"LICENSE",
20+
"README.md",
21+
"CHANGELOG.md",
22+
"_index.scss",
23+
"build"
24+
],
1725
"keywords": [
1826
"react-component",
1927
"react",

0 commit comments

Comments
 (0)