diff --git a/docs/api/README.md b/docs/api/README.md index 69f2cff850..9b3186d706 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -3,6 +3,10 @@ React Router API - [`Router`](/docs/api/Router.md) +- [`Router.run`](/docs/api/run.md) + +- [`Router.create`](/docs/api/create.md) + - Components - [`DefaultRoute`](/docs/api/components/DefaultRoute.md) - [`Link`](/docs/api/components/Link.md) @@ -10,13 +14,13 @@ React Router API - [`Redirect`](/docs/api/components/Redirect.md) - [`Route`](/docs/api/components/Route.md) - [`RouteHandler`](/docs/api/components/RouteHandler.md) - - [`Routes`](/docs/api/components/Routes.md) - Mixins - [`State`](/docs/api/mixins/State.md) - [`Navigation`](/docs/api/mixins/Navigation.md) - Misc + - [`Location`](/docs/api/misc/Location.md) - [`transition`](/docs/api/misc/transition.md) Public Modules diff --git a/docs/api/run.md b/docs/api/run.md index 7436d24a12..36073c5f88 100644 --- a/docs/api/run.md +++ b/docs/api/run.md @@ -19,7 +19,7 @@ Your route config. See [Route][1] ### `location` optional -Defaults to [`Router.HashLocation`][2]. If given a `Location` object, it +Defaults to `Router.HashLocation`. If given a `Location` object, it will setup and listen for changes on it, if given a string path, the router will immediately match that path and callback. @@ -57,10 +57,10 @@ An object containing the matched state. ##### `state.matches` -An array of the matched [routes][3]. Very useful for fetching data before +An array of the matched [routes][1]. Very useful for fetching data before rendering. -See also: [Route][3]. +See also: [Route][1]. ##### `state.activeParams` @@ -87,7 +87,7 @@ Router.run(routes, function (Handler) { ``` Sample data fetching using `state.matches`. Check out the -[async-data][4] example. +[async-data][2] example. ```js var resolveHash = require('when/keys').all; @@ -137,7 +137,5 @@ something.serve(function (req, res) { ``` [1]:./components/Route.md - [2]:./locations/HashLocation.md - [3]:./classes/Route.md - [4]:https://github.com/rackt/react-router/tree/latest/examples/async-data + [2]:https://github.com/rackt/react-router/tree/latest/examples/async-data diff --git a/docs/guides/overview.md b/docs/guides/overview.md index 25179514ff..3c920de505 100644 --- a/docs/guides/overview.md +++ b/docs/guides/overview.md @@ -357,8 +357,8 @@ Scrolling By default, the router will manage the scroll position between route transitions. When a user clicks "back" or "forward", it will restore their scroll position. If they visit a new route, it will automatically -scroll the window to the top. You can configure this options on -[Routes][Routes]. +scroll the window to the top. You can configure this option with +[Router.create][create]. Bells and Whistles ------------------ @@ -418,7 +418,7 @@ redirecting transitions, query parameters and more. [AsyncState]:../api/mixins/AsyncState.md [Route]:../api/components/Route.md - [Routes]:../api/components/Routes.md + [create]: ../api/create.md [API]:../api/ [path-matching]:./path-matching.md