diff --git a/.gitbook.yaml b/.gitbook.yaml new file mode 100644 index 0000000000..29d261cfe0 --- /dev/null +++ b/.gitbook.yaml @@ -0,0 +1,4 @@ +root: ./docs +structure: + readme: ../README.md + summary: README.md diff --git a/.gitignore b/.gitignore index 48a5a336d1..a3ab034238 100644 --- a/.gitignore +++ b/.gitignore @@ -5,4 +5,3 @@ dist lib es coverage -_book diff --git a/SUMMARY.md b/SUMMARY.md deleted file mode 120000 index 0e01b4308c..0000000000 --- a/SUMMARY.md +++ /dev/null @@ -1 +0,0 @@ -docs/README.md \ No newline at end of file diff --git a/book.json b/book.json deleted file mode 100644 index 7f4000417a..0000000000 --- a/book.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "gitbook": "3.2.2", - "title": "Redux", - "plugins": ["edit-link", "prism", "-highlight", "github", "anchorjs", "algolia"], - "pluginsConfig": { - "edit-link": { - "base": "https://github.com/reactjs/redux/tree/master", - "label": "Edit This Page" - }, - "github": { - "url": "https://github.com/reactjs/redux/" - }, - "algolia": { - "index": "redux-docs", - "applicationID": "BC2QB3G2G4", - "publicKey": "75eb88bb56d8cf8d17b6366a2c8e5fcd", - "freeAccount": "false" - }, - "theme-default": { - "styles": { - "website": "build/gitbook.css" - } - } - } -} diff --git a/docs/README.md b/docs/README.md index 46dbfaf9bb..4daf13dbbd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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) diff --git a/package.json b/package.json index b53a84c64f..440ceb6f4f 100644 --- a/package.json +++ b/package.json @@ -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 git@github.com:reactjs/redux gh-pages --force" + "examples:test": "cross-env CI=true babel-node examples/testAll.js" }, "repository": { "type": "git", @@ -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",