Merge pull request #1909 from bookshelf/rg-new-docs

Documentation website redesign
bookshelf · Nov 4, 2018 · 5b5b7f9 · 5b5b7f9
2 parents 55d0c30 + 7b33289
commit 5b5b7f9
Show file tree

Hide file tree

Showing 45 changed files with 29,226 additions and 249 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,4 @@ node_modules
 npm-debug.log
 tmp
 coverage/
-index.html
-docs/
 .jsdoc-temp/
diff --git a/.npmignore b/.npmignore
@@ -1,7 +1,7 @@
 docs/
 tutorials/
 test/
-index.html
+.github/
 .eslintrc
 .istanbul.yml
 .travis.yml

diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
-# [bookshelf.js](http://bookshelfjs.org)
+# bookshelf.js
 
 [![NPM Version](https://img.shields.io/npm/v/bookshelf.svg?style=flat)](https://www.npmjs.com/package/bookshelf)
-[![Build Status](https://travis-ci.org/bookshelf/bookshelf.svg?branch=master)](https://travis-ci.org/bookshelf/bookshelf)
+[![Build Status](https://api.travis-ci.org/bookshelf/bookshelf.svg?branch=master)](https://travis-ci.org/bookshelf/bookshelf)
 [![Dependency Status](https://david-dm.org/bookshelf/bookshelf/status.svg)](https://david-dm.org/bookshelf/bookshelf)
 [![devDependency Status](https://david-dm.org/bookshelf/bookshelf/dev-status.svg)](https://david-dm.org/bookshelf/bookshelf?type=dev)
 
@@ -11,10 +11,6 @@ It is designed to work well with PostgreSQL, MySQL, and SQLite3.
 
 [Website and documentation](http://bookshelfjs.org). The project is [hosted on GitHub](http://github.com/bookshelf/bookshelf/), and has a comprehensive [test suite](https://travis-ci.org/bookshelf/bookshelf).
 
-## Notice
-
-This project is currently undergoing some changes. You may want to [read the discussion about the future of bookshelf.js](https://github.com/bookshelf/bookshelf/issues/1600) on GitHub.
-
 ## Introduction
 
 Bookshelf aims to provide a simple library for common tasks when querying databases in JavaScript, and forming relations between these objects, taking a lot of ideas from the the [Data Mapper Pattern](http://en.wikipedia.org/wiki/Data_mapper_pattern).
@@ -79,7 +75,10 @@ var Post = bookshelf.Model.extend({
 Here is an example to get you started:
 
 ```js
-var knex = require('knex')({client: 'mysql', connection: process.env.MYSQL_DATABASE_CONNECTION });
+var knex = require('knex')({
+  client: 'mysql',
+  connection: process.env.MYSQL_DATABASE_CONNECTION
+});
 var bookshelf = require('bookshelf')(knex);
 
 var User = bookshelf.Model.extend({

diff --git a/docs/api.html b/docs/api.html
diff --git a/docs/bookshelf.js.html b/docs/bookshelf.js.html
@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <link rel="icon" href="images/favicon.ico" />
+    <link rel="canonical" href="http://bookshelfjs.org" />
+    <title>Bookshelf.js | bookshelf.js</title>
+    <!--
+    ._.                                                      ._.
+    | |    ______             _        _          _  __      | |
+    | |    | ___ \           | |      | |        | |/ _|     | |
+    | |    | |_/ / ___   ___ | | _____| |__   ___| | |_      | |
+    | |    | ___ \/ _ \ / _ \| |/ / __| '_ \ / _ \ |  _|     | |
+    | |    | |_/ / (_) | (_) |   <\__ \ | | |  __/ | |       | |
+    | |____\____/_\___/_\___/|_|\_\___/_|_|_|\___|_|_|_______| |
+    |                                                          |
+    \________\  /__________________________________\  /________/
+              \/                                    \/
+    -->
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+
+    <!-- Import fonts from Open Font Library -->
+    <link rel="stylesheet" media="screen" href="https://fontlibrary.org/face/carlito" rel="stylesheet" type="text/css"/>
+    <link rel="stylesheet" media="screen" href="https://fontlibrary.org/face/average-mono" rel="stylesheet" type="text/css"/>
+    <link rel="stylesheet" media="screen" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" type="text/css"/>
+
+    <link type="text/css" rel="stylesheet" href="styles/main.css">
+  </head>
+  <body class="minami">
+    <nav class="main-navbar">
+      <a href="index.html"><img class="nav-logo" src="images/bookshelf-icon-inverted.svg" />Bookshelf.js
+</a>
+      <label for="show-menu" class="show-menu">
+        <i class="fa fa-bars fa-lg" aria-hidden="true"></i>
+      </label>
+      <input type="checkbox" id="show-menu" role="button" checked>
+      <ul id="menu">
+
+          <li>
+            <a href="tutorials.html"><i class="fa fa-file-text" aria-hidden="true"></i>Guides
+</a>
+          </li>
+
+
+          <li>
+            <a href="api.html"><i class="fa fa-book" aria-hidden="true"></i>API Reference
+</a>
+          </li>
+
+        <li>
+          <a href="https://github.com/bookshelf/bookshelf"><span class="fa fa-github"></span></a>
+        </li>
+      </ul>
+    </nav>
+
+    <div class="page-content">
+
+
+      <div class="main-container source">
+        <div class="main-column">
+
+            <h1 class="page-title">bookshelf.js</h1>
+
+
+
+
+
+
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/**
+ * (c) 2013-present Tim Griesser
+ * Bookshelf may be freely distributed under the MIT license.
+ * For all details and documentation:
+ * http://bookshelfjs.org
+ *
+ */
+module.exports = require('./lib/bookshelf');
+</code></pre>
+        </article>
+    </section>
+
+
+
+
+
+        </div>
+      </div>
+    </div>
+
+    <footer>
+      <div>
+        Documentation generated by
+        <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
+
+          on
+          November 4, 2018
+
+      </div>
+    </footer>
+
+    <script>prettyPrint();</script>
+    <script src="scripts/linenumber.js"></script>
+    <script src="scripts/main.js"></script>
+  </body>
+</html>
diff --git a/docs/images/bookshelf-icon-inverted.svg b/docs/images/bookshelf-icon-inverted.svg
diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico