Skip to content

Commit e79ae13

Browse files
jamespleasejamesplease
committed
Begin converting docs to new Gitbook
1 parent 90f8382 commit e79ae13

File tree

7 files changed

+69
-117
lines changed

7 files changed

+69
-117
lines changed

Diff for: ‎.bookignore

-8
This file was deleted.

Diff for: ‎.gitbook.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
structure:
2+
readme: INDEX.md
3+
summary: docs/README.md

Diff for: ‎INDEX.md

+5-23
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,8 @@
1-
<p align="center">
2-
<a href="http://redux-resource.js.org">
3-
<img src="https://user-images.githubusercontent.com/2322305/35489731-63e3bb20-044e-11e8-8211-b7d153722865.png" height="120" alt="Redux Resource Logo" aria-label="redux-resource.js.org" />
4-
</a>
5-
</p>
6-
7-
<p align="center">
8-
<a href="https://gitter.im/jmeas/redux-resource?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge">
9-
<img src="https://badges.gitter.im/jmeas/redux-resource.svg" alt="Redux Resource on Gitter" />
10-
</a>
11-
<a href="https://travis-ci.org/jamesplease/redux-resource">
12-
<img src="http://img.shields.io/travis/jamesplease/redux-resource.svg?style=flat" alt="Redux Resource Travis Builds" />
13-
</a>
14-
<a href="https://www.npmjs.com/package/redux-resource">
15-
<img src="https://img.shields.io/npm/v/redux-resource.svg" alt="Redux Resource NPM Package" />
16-
</a>
17-
<a href="https://coveralls.io/github/jamesplease/redux-resource?branch=master">
18-
<img src="https://coveralls.io/repos/github/jamesplease/redux-resource/badge.svg?branch=master" alt="Redux Resource Code Coverage" />
19-
</a>
20-
<a href="https://unpkg.com/redux-resource/dist/redux-resource.min.js">
21-
<img src="http://img.badgesize.io/https://unpkg.com/redux-resource/dist/redux-resource.min.js?compression=gzip" alt="Redux Resource gzip Size" />
22-
</a>
23-
</p>
1+
[![Travis build status](https://badges.gitter.im/jmeas/redux-resource.svg)](https://gitter.im/jmeas/redux-resource?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
2+
[![Travis build status](http://img.shields.io/travis/jamesplease/redux-resource.svg?style=flat)](https://travis-ci.org/jamesplease/redux-resource)
3+
[![npm version](https://img.shields.io/npm/v/redux-resource.svg)](https://www.npmjs.com/package/redux-resource)
4+
[![Test Coverage](https://coveralls.io/repos/github/jamesplease/redux-resource/badge.svg?branch=master)](https://coveralls.io/github/jamesplease/redux-resource?branch=master)
5+
[![gzip size](http://img.badgesize.io/https://unpkg.com/redux-resource/dist/redux-resource.min.js?compression=gzip)](https://unpkg.com/redux-resource/dist/redux-resource.min.js)
246

257
A tiny but powerful system for managing 'resources': data that is persisted to
268
remote servers.

Diff for: ‎SUMMARY.md

-60
This file was deleted.

Diff for: ‎book.json

-20
This file was deleted.

Diff for: ‎docs/README.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Table of Contents
2+
3+
* [Home](../INDEX.md)
4+
* [Introduction](introduction/README.md)
5+
* [Motivation](introduction/motivation.md)
6+
* [Core Concepts](introduction/core-concepts.md)
7+
* [Similar Projects](introduction/similar-projects.md)
8+
* [Examples](introduction/examples.md)
9+
* [Resources](resources/README.md)
10+
* [Resource Reducers](resources/resource-reducers.md)
11+
* [Resource Objects](resources/resource-objects.md)
12+
* [Meta](resources/meta.md)
13+
* [Lists](resources/lists.md)
14+
* [Modifying Resources](resources/modifying-resources.md)
15+
* [Requests](requests/README.md)
16+
* [Request Objects](requests/request-objects.md)
17+
* [Keys](requests/request-keys.md)
18+
* [Names](requests/request-names.md)
19+
* [Statuses](requests/request-statuses.md)
20+
* [Request Actions](requests/request-actions.md)
21+
* [Updating Lists](requests/updating-lists.md)
22+
* [Reading Resources](requests/reading-resources.md)
23+
* [Updating Resources](requests/updating-resources.md)
24+
* [Creating Resources](requests/creating-resources.md)
25+
* [Deleting Resources](requests/deleting-resources.md)
26+
* [Other Guides](other-guides/README.md)
27+
* [Usage With React](other-guides/usage-with-react.md)
28+
* [Tracking Request Statuses](other-guides/tracking-request-statuses.md)
29+
* [Using Request Statuses](other-guides/using-request-statuses.md)
30+
* [Custom Action Types](other-guides/custom-action-types.md)
31+
* [Migration Guides](other-guides/migration-guides.md)
32+
* [Recipes](recipes/README.md)
33+
* [Forms](recipes/forms.md)
34+
* [Canceling Requests](recipes/canceling-requests.md)
35+
* [Unauthorized Responses](recipes/unauthorized-responses.md)
36+
* [User Feedback](recipes/user-feedback.md)
37+
* [Related Resources](recipes/related-resources.md)
38+
* [Caching](recipes/caching.md)
39+
* [Ecosystem Extras](extras/README.md)
40+
* [Redux Resource Action Creators](extras/redux-resource-action-creators.md)
41+
* [Redux Resource XHR](extras/redux-resource-xhr.md)
42+
* [Redux Resource Prop Types](extras/redux-resource-prop-types.md)
43+
* [Redux Resource Plugins](extras/redux-resource-plugins.md)
44+
* [HTTP Status Codes](extras/http-status-codes-plugin.md)
45+
* [Selection](extras/selection-plugin.md)
46+
* [Reset](extras/reset-plugin.md)
47+
* [Included Resources](extras/included-resources-plugin.md)
48+
* [FAQ](faq/README.md)
49+
* [General](faq/general.md)
50+
* [State Tree](faq/state-tree.md)
51+
* [Actions](faq/actions.md)
52+
* [Lists](faq/lists.md)
53+
* [API Reference](api-reference/README.md)
54+
* [resourceReducer](api-reference/resource-reducer.md)
55+
* [getStatus](api-reference/get-status.md)
56+
* [getResources](api-reference/get-resources.md)
57+
* [upsertResources](api-reference/upsert-resources.md)
58+
* [setResourceMeta](api-reference/set-resource-meta.md)
59+
* [actionTypes](api-reference/action-types.md)
60+
* [requestStatuses](api-reference/request-statuses.md)

Diff for: ‎package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,7 @@
1111
"publish": "npm run build && lerna publish",
1212
"bootstrap": "lerna bootstrap",
1313
"contributors:add": "all-contributors add",
14-
"contributors:generate": "all-contributors generate",
15-
"docs:watch": "npm run docs:prepare && gitbook serve",
16-
"docs:prepare": "gitbook install",
17-
"docs:clean": "rimraf _book",
18-
"docs:build": "npm run docs:prepare && gitbook build",
19-
"docs:publish": "npm run docs:clean && npm run docs:build && cp CNAME _book && cd _book && git init && git commit --allow-empty -m 'update book' && git checkout -b gh-pages && touch .nojekyll && git add . && git commit -am 'update book' && git push git@github.com:jamesplease/redux-resource gh-pages --force"
14+
"contributors:generate": "all-contributors generate"
2015
},
2116
"license": "MIT",
2217
"devDependencies": {

0 commit comments

Comments
 (0)