Skip to content

New documentation on the upcoming GitBook #2837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 16, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
root: ./docs
structure:
readme: ../README.md
summary: README.md
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ dist
lib
es
coverage
_book
1 change: 0 additions & 1 deletion SUMMARY.md

This file was deleted.

25 changes: 0 additions & 25 deletions book.json

This file was deleted.

136 changes: 68 additions & 68 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,71 @@
# Table of Contents

* [Read Me](/README.md)
* [Introduction](/docs/introduction/README.md)
* [Motivation](/docs/introduction/Motivation.md)
* [Core Concepts](/docs/introduction/CoreConcepts.md)
* [Three Principles](/docs/introduction/ThreePrinciples.md)
* [Prior Art](/docs/introduction/PriorArt.md)
* [Learning Resources](/docs/introduction/LearningResources.md)
* [Ecosystem](/docs/introduction/Ecosystem.md)
* [Examples](/docs/introduction/Examples.md)
* [Basics](/docs/basics/README.md)
* [Actions](/docs/basics/Actions.md)
* [Reducers](/docs/basics/Reducers.md)
* [Store](/docs/basics/Store.md)
* [Data Flow](/docs/basics/DataFlow.md)
* [Usage with React](/docs/basics/UsageWithReact.md)
* [Example: Todo List](/docs/basics/ExampleTodoList.md)
* [Advanced](/docs/advanced/README.md)
* [Async Actions](/docs/advanced/AsyncActions.md)
* [Async Flow](/docs/advanced/AsyncFlow.md)
* [Middleware](/docs/advanced/Middleware.md)
* [Usage with React Router](/docs/advanced/UsageWithReactRouter.md)
* [Example: Reddit API](/docs/advanced/ExampleRedditAPI.md)
* [Read Me](../README.md)
* [Introduction](introduction/README.md)
* [Motivation](introduction/Motivation.md)
* [Core Concepts](introduction/CoreConcepts.md)
* [Three Principles](introduction/ThreePrinciples.md)
* [Prior Art](introduction/PriorArt.md)
* [Learning Resources](introduction/LearningResources.md)
* [Ecosystem](introduction/Ecosystem.md)
* [Examples](introduction/Examples.md)
* [Basics](basics/README.md)
* [Actions](basics/Actions.md)
* [Reducers](basics/Reducers.md)
* [Store](basics/Store.md)
* [Data Flow](basics/DataFlow.md)
* [Usage with React](basics/UsageWithReact.md)
* [Example: Todo List](basics/ExampleTodoList.md)
* [Advanced](advanced/README.md)
* [Async Actions](advanced/AsyncActions.md)
* [Async Flow](advanced/AsyncFlow.md)
* [Middleware](advanced/Middleware.md)
* [Usage with React Router](advanced/UsageWithReactRouter.md)
* [Example: Reddit API](advanced/ExampleRedditAPI.md)
* Next Steps
* [Recipes](/docs/recipes/README.md)
* [Migrating to Redux](/docs/recipes/MigratingToRedux.md)
* [Using Object Spread Operator](/docs/recipes/UsingObjectSpreadOperator.md)
* [Reducing Boilerplate](/docs/recipes/ReducingBoilerplate.md)
* [Server Rendering](/docs/recipes/ServerRendering.md)
* [Writing Tests](/docs/recipes/WritingTests.md)
* [Computing Derived Data](/docs/recipes/ComputingDerivedData.md)
* [Implementing Undo History](/docs/recipes/ImplementingUndoHistory.md)
* [Isolating Subapps](/docs/recipes/IsolatingSubapps.md)
* [Structuring Reducers](/docs/recipes/StructuringReducers.md)
* [Prerequisite Concepts](/docs/recipes/reducers/PrerequisiteConcepts.md)
* [Basic Reducer Structure](/docs/recipes/reducers/BasicReducerStructure.md)
* [Splitting Reducer Logic](/docs/recipes/reducers/SplittingReducerLogic.md)
* [Refactoring Reducers Example](/docs/recipes/reducers/RefactoringReducersExample.md)
* [Using `combineReducers`](/docs/recipes/reducers/UsingCombineReducers.md)
* [Beyond `combineReducers`](/docs/recipes/reducers/BeyondCombineReducers.md)
* [Normalizing State Shape](/docs/recipes/reducers/NormalizingStateShape.md)
* [Updating Normalized Data](/docs/recipes/reducers/UpdatingNormalizedData.md)
* [Reusing Reducer Logic](/docs/recipes/reducers/ReusingReducerLogic.md)
* [Immutable Update Patterns](/docs/recipes/reducers/ImmutableUpdatePatterns.md)
* [Initializing State](/docs/recipes/reducers/InitializingState.md)
* [Using Immutable.JS with Redux](/docs/recipes/UsingImmutableJS.md)
* [FAQ](/docs/FAQ.md)
* [General](/docs/faq/General.md)
* [Reducers](/docs/faq/Reducers.md)
* [Organizing State](/docs/faq/OrganizingState.md)
* [Store Setup](/docs/faq/StoreSetup.md)
* [Actions](/docs/faq/Actions.md)
* [Immutable Data](/docs/faq/ImmutableData.md)
* [Code Structure](/docs/faq/CodeStructure.md)
* [Performance](/docs/faq/Performance.md)
* [Design Decisions](/docs/faq/DesignDecisions.md)
* [React Redux](/docs/faq/ReactRedux.md)
* [Miscellaneous](/docs/faq/Miscellaneous.md)
* [Troubleshooting](/docs/Troubleshooting.md)
* [Glossary](/docs/Glossary.md)
* [API Reference](/docs/api/README.md)
* [createStore](/docs/api/createStore.md)
* [Store](/docs/api/Store.md)
* [combineReducers](/docs/api/combineReducers.md)
* [applyMiddleware](/docs/api/applyMiddleware.md)
* [bindActionCreators](/docs/api/bindActionCreators.md)
* [compose](/docs/api/compose.md)
* [Change Log](/CHANGELOG.md)
* [Patrons](/PATRONS.md)
* [Feedback](/docs/Feedback.md)
* [Recipes](recipes/README.md)
* [Migrating to Redux](recipes/MigratingToRedux.md)
* [Using Object Spread Operator](recipes/UsingObjectSpreadOperator.md)
* [Reducing Boilerplate](recipes/ReducingBoilerplate.md)
* [Server Rendering](recipes/ServerRendering.md)
* [Writing Tests](recipes/WritingTests.md)
* [Computing Derived Data](recipes/ComputingDerivedData.md)
* [Implementing Undo History](recipes/ImplementingUndoHistory.md)
* [Isolating Subapps](recipes/IsolatingSubapps.md)
* [Structuring Reducers](recipes/StructuringReducers.md)
* [Prerequisite Concepts](recipes/reducers/PrerequisiteConcepts.md)
* [Basic Reducer Structure](recipes/reducers/BasicReducerStructure.md)
* [Splitting Reducer Logic](recipes/reducers/SplittingReducerLogic.md)
* [Refactoring Reducers Example](recipes/reducers/RefactoringReducersExample.md)
* [Using `combineReducers`](recipes/reducers/UsingCombineReducers.md)
* [Beyond `combineReducers`](recipes/reducers/BeyondCombineReducers.md)
* [Normalizing State Shape](recipes/reducers/NormalizingStateShape.md)
* [Updating Normalized Data](recipes/reducers/UpdatingNormalizedData.md)
* [Reusing Reducer Logic](recipes/reducers/ReusingReducerLogic.md)
* [Immutable Update Patterns](recipes/reducers/ImmutableUpdatePatterns.md)
* [Initializing State](recipes/reducers/InitializingState.md)
* [Using Immutable.JS with Redux](recipes/UsingImmutableJS.md)
* [FAQ](FAQ.md)
* [General](faq/General.md)
* [Reducers](faq/Reducers.md)
* [Organizing State](faq/OrganizingState.md)
* [Store Setup](faq/StoreSetup.md)
* [Actions](faq/Actions.md)
* [Immutable Data](faq/ImmutableData.md)
* [Code Structure](faq/CodeStructure.md)
* [Performance](faq/Performance.md)
* [Design Decisions](faq/DesignDecisions.md)
* [React Redux](faq/ReactRedux.md)
* [Miscellaneous](faq/Miscellaneous.md)
* [Troubleshooting](Troubleshooting.md)
* [Glossary](Glossary.md)
* [API Reference](api/README.md)
* [createStore](api/createStore.md)
* [Store](api/Store.md)
* [combineReducers](api/combineReducers.md)
* [applyMiddleware](api/applyMiddleware.md)
* [bindActionCreators](api/bindActionCreators.md)
* [compose](api/compose.md)
* [Change Log](../CHANGELOG.md)
* [Patrons](../PATRONS.md)
* [Feedback](Feedback.md)
8 changes: 1 addition & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,7 @@
"build": "npm run build:commonjs && npm run build:es && npm run build:umd && npm run build:umd:min",
"prepare": "npm run clean && npm run format:check && npm run lint && npm test && npm run build",
"examples:lint": "eslint examples",
"examples:test": "cross-env CI=true babel-node examples/testAll.js",
"docs:clean": "rimraf _book",
"docs:prepare": "gitbook install",
"docs:build": "npm run docs:prepare && gitbook build -g reactjs/redux && cp logo/apple-touch-icon.png _book/gitbook/images/apple-touch-icon-precomposed-152.png && cp logo/favicon.ico _book/gitbook/images",
"docs:watch": "npm run docs:prepare && gitbook serve",
"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 [email protected]:reactjs/redux gh-pages --force"
"examples:test": "cross-env CI=true babel-node examples/testAll.js"
},
"repository": {
"type": "git",
Expand Down Expand Up @@ -81,7 +76,6 @@
"eslint-plugin-import": "^2.8.0",
"eslint-plugin-jsx-a11y": "^6.0.3",
"eslint-plugin-react": "^7.6.1",
"gitbook-cli": "^2.3.2",
"glob": "^7.1.1",
"jest": "^22.3.0",
"prettier": "^1.10.2",
Expand Down