Skip to content

Commit a7333c0

Browse files
committed
Format docs and stuff
1 parent 579ea46 commit a7333c0

File tree

6 files changed

+27
-28
lines changed

6 files changed

+27
-28
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313

1414
The `redux-starter-kit` package is intended to help address three common complaints about Redux:
1515

16-
- "Configuring a Redux store is too complicated"
17-
- "I have to add a lot of packages to get Redux to do anything useful"
18-
- "Redux requires too much boilerplate code"
16+
* "Configuring a Redux store is too complicated"
17+
* "I have to add a lot of packages to get Redux to do anything useful"
18+
* "Redux requires too much boilerplate code"
1919

2020
We can't solve every use case, but in the spirit of [`create-react-app`](https://github.com/facebook/create-react-app) and [`apollo-boost`](https://dev-blog.apollodata.com/zero-config-graphql-state-management-27b1f1b3c2c3), we can try to provide some tools that abstract over the setup process and handle the most common use cases, as well as include some useful utilities that will let the user simplify their application code.
2121

@@ -25,11 +25,11 @@ This package is _not_ intended to solve every possible complaint about Redux, an
2525

2626
`redux-starter-kit` includes:
2727

28-
- A `configureStore()` function with simplified configuration options. It can automatically combine your slice reducers, adds whatever Redux middleware you supply, includes `redux-thunk` by default, and enables use of the Redux DevTools Extension.
29-
- A `createReducer()` utility that lets you supply a lookup table of action types to case reducer functions, rather than writing switch statements. In addition, it automatically uses the [`immer` library](https://github.com/mweststrate/immer) to let you write simpler immutable updates with normal mutative code, like `state.todos[3].completed = true`.
30-
- A `createAction()` utility that returns an action creator function for the given action type string. The function itself has `toString()` defined, so that it can be used in place of the type constant.
31-
- A `createSlice()` function that accepts a set of reducer functions, a slice name, and an initial state value, and automatically generates corresponding action creators, types, and simple selector functions.
32-
- An improved version of the widely used `createSelector` utility for creating memoized selector functions, which can accept string keypaths as "input selectors" (re-exported from the [`selectorator` library](https://github.com/planttheidea/selectorator)).
28+
* A `configureStore()` function with simplified configuration options. It can automatically combine your slice reducers, adds whatever Redux middleware you supply, includes `redux-thunk` by default, and enables use of the Redux DevTools Extension.
29+
* A `createReducer()` utility that lets you supply a lookup table of action types to case reducer functions, rather than writing switch statements. In addition, it automatically uses the [`immer` library](https://github.com/mweststrate/immer) to let you write simpler immutable updates with normal mutative code, like `state.todos[3].completed = true`.
30+
* A `createAction()` utility that returns an action creator function for the given action type string. The function itself has `toString()` defined, so that it can be used in place of the type constant.
31+
* A `createSlice()` function that accepts a set of reducer functions, a slice name, and an initial state value, and automatically generates corresponding action creators, types, and simple selector functions.
32+
* An improved version of the widely used `createSelector` utility for creating memoized selector functions, which can accept string keypaths as "input selectors" (re-exported from the [`selectorator` library](https://github.com/planttheidea/selectorator)).
3333

3434
## Documentation
3535

docs/api/createSelector.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ For more specifics, see the [`selectorator` usage documentation](https://github.
1313

1414
```ts
1515
function createSelector(
16-
// Can either be:
17-
// - An array containing selector functions, string keypaths, and argument objects
18-
// - An object whose keys are selector functions and string keypaths
19-
paths : Array<Function | string | Object> | Object<string, string | Function>
16+
// Can either be:
17+
// - An array containing selector functions, string keypaths, and argument objects
18+
// - An object whose keys are selector functions and string keypaths
19+
paths: Array<Function | string | Object> | Object<string, string | Function>
2020
)
2121
```
2222

docs/introduction/quick-start.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ hide_title: true
1111

1212
The **`redux-starter-kit`** package is intended to help address three common concerns about Redux:
1313

14-
- "Configuring a Redux store is too complicated"
15-
- "I have to add a lot of packages to get Redux to do anything useful"
16-
- "Redux requires too much boilerplate code"
14+
* "Configuring a Redux store is too complicated"
15+
* "I have to add a lot of packages to get Redux to do anything useful"
16+
* "Redux requires too much boilerplate code"
1717

1818
We can't solve every use case, but in the spirit of [`create-react-app`](https://github.com/facebook/create-react-app) and [`apollo-boost`](https://dev-blog.apollodata.com/zero-config-graphql-state-management-27b1f1b3c2c3), we can try to provide some tools that abstract over the setup process and handle the most common use cases, as well as include some useful utilities that will let the user simplify their application code.
1919

@@ -27,11 +27,11 @@ you make your Redux code better.
2727

2828
`redux-starter-kit` includes:
2929

30-
- A `configureStore()` function with simplified configuration options. It can automatically combine your slice reducers, adds whatever Redux middleware you supply, includes `redux-thunk` by default, and enables use of the Redux DevTools Extension.
31-
- A `createReducer()` utility that lets you supply a lookup table of action types to case reducer functions, rather than writing switch statements. In addition, it automatically uses the [`immer` library](https://github.com/mweststrate/immer) to let you write simpler immutable updates with normal mutative code, like `state.todos[3].completed = true`.
32-
- A `createAction()` utility that returns an action creator function for the given action type string. The function itself has `toString()` defined, so that it can be used in place of the type constant.
33-
- A `createSlice()` function that accepts a set of reducer functions, a slice name, and an initial state value, and automatically generates corresponding action creators, types, and simple selector functions.
34-
- An improved version of the widely used `createSelector` utility for creating memoized selector functions, which can accept string keypaths as "input selectors" (re-exported from the [`selectorator` library](https://github.com/planttheidea/selectorator)).
30+
* A `configureStore()` function with simplified configuration options. It can automatically combine your slice reducers, adds whatever Redux middleware you supply, includes `redux-thunk` by default, and enables use of the Redux DevTools Extension.
31+
* A `createReducer()` utility that lets you supply a lookup table of action types to case reducer functions, rather than writing switch statements. In addition, it automatically uses the [`immer` library](https://github.com/mweststrate/immer) to let you write simpler immutable updates with normal mutative code, like `state.todos[3].completed = true`.
32+
* A `createAction()` utility that returns an action creator function for the given action type string. The function itself has `toString()` defined, so that it can be used in place of the type constant.
33+
* A `createSlice()` function that accepts a set of reducer functions, a slice name, and an initial state value, and automatically generates corresponding action creators, types, and simple selector functions.
34+
* An improved version of the widely used `createSelector` utility for creating memoized selector functions, which can accept string keypaths as "input selectors" (re-exported from the [`selectorator` library](https://github.com/planttheidea/selectorator)).
3535

3636
## Installation
3737

src/configureStore.test.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ describe('getDefaultMiddleware', () => {
1111
})
1212

1313
it('returns an array with additional middleware in development', () => {
14-
const middleware = getDefaultMiddleware(false);
14+
const middleware = getDefaultMiddleware(false)
1515
expect(middleware[middleware.length - 1]).toEqual(thunk)
16-
expect(middleware.length).toBeGreaterThan(1);
16+
expect(middleware.length).toBeGreaterThan(1)
1717
})
1818
})
1919

website/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ This website was created with [Docusaurus](https://docusaurus.io/).
22

33
# What's In This Document
44

5-
- [Get Started in 5 Minutes](#get-started-in-5-minutes)
6-
- [Directory Structure](#directory-structure)
7-
- [Editing Content](#editing-content)
8-
- [Adding Content](#adding-content)
9-
- [Full Documentation](#full-documentation)
5+
* [Get Started in 5 Minutes](#get-started-in-5-minutes)
6+
* [Directory Structure](#directory-structure)
7+
* [Editing Content](#editing-content)
8+
* [Adding Content](#adding-content)
9+
* [Full Documentation](#full-documentation)
1010

1111
# Get Started in 5 Minutes
1212

website/siteConfig.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ const siteConfig = {
1919
indexName: 'redux-starter-kit',
2020
algoliaOptions: {}
2121
},
22-
2322

2423
// Used for publishing and more
2524
projectName: 'redux-starter-kit',

0 commit comments

Comments
 (0)