Skip to content

Commit

Permalink
[changed] host docs on GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
thealjey committed Oct 13, 2015
1 parent 9cdeb94 commit c232c9f
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 9 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# react-bootstrap-combobox
*A combo-box component for React Bootstrap.*

[Project Home](https://github.com/thealjey/react-bootstrap-combobox)
|
[API Docs](https://thealjey.github.io/react-bootstrap-combobox)

[![Build Status](https://travis-ci.org/thealjey/react-bootstrap-combobox.svg?branch=master)](https://travis-ci.org/thealjey/react-bootstrap-combobox)
[![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)
[![Code Climate](https://codeclimate.com/github/thealjey/react-bootstrap-combobox/badges/gpa.svg)](https://codeclimate.com/github/thealjey/react-bootstrap-combobox)
Expand Down Expand Up @@ -31,11 +35,6 @@ performance increase from React for free!
npm i react-bootstrap-combobox --save
```

### API Documentation

To get better acquainted with the available tools feel free to skim through the auto-generated
[API Docs](https://rawgit.com/thealjey/react-bootstrap-combobox/master/docs/index.html).

### Usage

You need to include the **"_index.scss"** file from this package.
Expand Down
3 changes: 3 additions & 0 deletions bin/build.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import {JS, NativeProcess, SASSLint} from 'webcompiler';
import {join} from 'path';
import {createReadStream, createWriteStream} from 'fs';

const rootDir = join(__dirname, '..'),
binDir = join(rootDir, 'bin'),
Expand All @@ -25,6 +26,8 @@ new SASSLint().run([style, devStyle], function () {
if (e) {
return console.error(e);
}
createReadStream(join(rootDir, 'LICENSE')).pipe(createWriteStream(join(docsDir, 'LICENSE')));
createReadStream(join(rootDir, 'doc_readme.md')).pipe(createWriteStream(join(docsDir, 'README.md')));
console.log('\x1b[32mGenerated API documentation!\x1b[0m');
npm.run(Function.prototype, ['test'], {stdio: 'inherit'});
}, [buildDir, '-d', docsDir, '-R', readme, '-c', jsdocConfig]);
Expand Down
6 changes: 6 additions & 0 deletions doc_readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# "react-bootstrap-combobox" Documentation Website
*JSDoc generated API documentation site.*

[Project Home](https://github.com/thealjey/react-bootstrap-combobox)
|
[API Docs](https://thealjey.github.io/react-bootstrap-combobox)
21 changes: 21 additions & 0 deletions docs/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015 Eugene Kuzmenko

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
6 changes: 6 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# "react-bootstrap-combobox" Documentation Website
*JSDoc generated API documentation site.*

[Project Home](https://github.com/thealjey/react-bootstrap-combobox)
|
[API Docs](https://thealjey.github.io/react-bootstrap-combobox)
7 changes: 4 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ <h3> </h3>

<section>
<article><h1>react-bootstrap-combobox</h1><p><em>A combo-box component for React Bootstrap.</em></p>
<p><a href="https://github.com/thealjey/react-bootstrap-combobox">Project Home</a>
|
<a href="https://thealjey.github.io/react-bootstrap-combobox">API Docs</a></p>
<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>
<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>
<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>
Expand All @@ -62,9 +65,7 @@ <h3>Features</h3><ol>
</ol>
<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
performance increase from React for free!</p>
<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
<a href="https://rawgit.com/thealjey/react-bootstrap-combobox/master/docs/index.html">API Docs</a>.</p>
<h3>Usage</h3><p>You need to include the <strong>&quot;_index.scss&quot;</strong> file from this package.
<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.
If you are using <a href="https://github.com/thealjey/webcompiler">webcompiler</a> then you can simply do:</p>
<pre class="prettyprint source lang-SCSS"><code>// import Bootstrap
@import &quot;bootstrap&quot;;
Expand Down
10 changes: 9 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,20 @@
"lint": "eslint ./",
"build": "babel-node bin/build",
"start": "babel-node bin/server",
"release": "release"
"release": "release",
"postpublish": "git push origin `git subtree split --prefix docs master`:gh-pages --force"
},
"repository": {
"type": "git",
"url": "git+https://github.com/thealjey/react-bootstrap-combobox.git"
},
"files": [
"LICENSE",
"README.md",
"CHANGELOG.md",
"_index.scss",
"build"
],
"keywords": [
"react-component",
"react",
Expand Down

0 comments on commit c232c9f

Please sign in to comment.