Skip to content

Commit

Permalink
Merge pull request #601 from Abazhenov/dev
Browse files Browse the repository at this point in the history
Docs Formatting
  • Loading branch information
Havunen authored Dec 18, 2016
2 parents e91cbc8 + a53aa47 commit 00f5c72
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/api/inferno-redux.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Inferno Redux
---

We understand that a lot of application in the React ecosystem use [Redux](//reduxjs.org) to manage data. Thus we have a created a port of React-Redux for Inferno to ease the process of porting an application over.
We understand that a lot of applications in the React ecosystem use [Redux](//reduxjs.org) to manage data. Thus we have created a port of React-Redux for Inferno to ease the process of porting an application over.

## `Provider`

Expand Down
16 changes: 0 additions & 16 deletions docs/api/inferno.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,22 +110,6 @@ If a component has been mounted into the DOM, this returns the corresponding nat

**Note**: we recommend using a `ref` callback on a component to find its instance, rather than using `findDOMNode`. `findDOMNode` cannot be used on functional components.

## createRenderer

`createRenderer` allows for functional composition when rendering content to the DOM. An example of this is shown below:

```javascript
import Inferno from 'inferno';
import { scan, map } from 'most';

...
const model$ = scan(update, 0, actions$);
const vNodes$ = map(view(actions$), model$);
const renderer = Inferno.createRenderer();
const runApp = () => scan(renderer, container, vNodes$).drain();

runApp();
```

## disableRecycling
As an application changes components will be reused as they are mounted and unmounted from the DOM. By default Inferno enables *recycling* to have a pool of components which can be reused when components are mounted into the DOM. However if you wish to disable this feature you can.
Expand Down
13 changes: 9 additions & 4 deletions docs/guides/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
title: Get Started
---

There are three ways to get setup with Inferno, the simple `create-inferno-app`, installation via NPM, or using the Cloudfare CDN.
There are three ways to get setup with Inferno: using the simple `create-inferno-app`, installing via NPM, or by using the Cloudfare CDN.

## Create Inferno App

Similarly to React you can get started by using `create-inferno-app`. Make sure that you have Node installed
Similar to React's `create-react-app`, you can get started by using `create-inferno-app`. Make sure that you have Node installed

```
(sudo) npm install -g create-inferno-app
Expand All @@ -18,13 +18,18 @@ npm start
Then navigate to [`http://localhost:8080/`](http://localhost:8080) to view the application.

## NPM Installation
The core Inferno is packaged on NPM as `inferno`.
Inferno is packaged on NPM as `inferno`.

<div>
`npm install inferno --save`
</div>

Which will set you up with the core package and everything you need to start creating components and rendering them, but you'll probably want to take a look at our [other packages]({{site.url}}/guides/architecture) for convenience.
This will set you up with the core package and everything you need to start creating components and rendering them, but you'll probably want to take a look at our [other packages]({{site.url}}/guides/architecture) for convenience.

## Cloudfare

Pre-bundled files for browser consumption can be found on [our cdnjs](https://cdnjs.com/libraries/inferno):

```
https://cdnjs.cloudflare.com/ajax/libs/inferno/1.0.0-beta36/inferno.min.js
```

0 comments on commit 00f5c72

Please sign in to comment.