Skip to content

Commit dc33836

Browse files
committed
Documentation improvements
1 parent 12b0878 commit dc33836

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -82,26 +82,24 @@ and to allow search engines to crawl your pages for SEO purposes.
8282
Returns a `RenderedComponent` instance, which can be passed directly into templates
8383
to output the component's HTML.
8484

85-
**Note**: components are loaded with [Babel](http://babeljs.io) which enables you
86-
to use JSX + ES6/7 in your components.
87-
8885
Arguments:
8986

90-
- `path_to_source` — a path to a JS or JSX file which exports the component. If the
87+
- **path_to_source** — a path to a JS or JSX file which exports the component. If the
9188
path is relative, django's static file finders will be used to find the file.
92-
- `props` *optional* — a dictonary that will be serialised to JSON and passed to
89+
- **props** *optional* — a dictonary that will be serialised to JSON and passed to
9390
the component during the renderering process.
94-
- `to_static_markup` *optional* — a boolean indicating that React's `renderToStaticMarkup`
91+
- **to_static_markup** *optional* — a boolean indicating that React's `renderToStaticMarkup`
9592
method should be used for the rendering. Defaults to `False`, which causes React's
9693
`renderToString` method to be used.
97-
- `bundle` *optional* - a boolean indicating that the component should be bundled for
94+
- **bundle** *optional* - a boolean indicating that the component should be bundled for
9895
reuse on the client-side. If `translate` or `watch_source` are used, this argument is
9996
ignored.
100-
- `translate` *optional* - a boolean indicating that the component should be translated
101-
from JSX and ES6/7 before rendering.
102-
- `watch_source` *optional* — a boolean indicating that the renderer should watch your source
97+
- **translate** *optional* - a boolean indicating that the component should be translated
98+
from JSX and ES6/7 before rendering. Components are translated with
99+
[Babel](http://babeljs.io).
100+
- **watch_source** *optional* — a boolean indicating that the renderer should watch your source
103101
files and rebuild the component whenever it changes. If not defined, defaults to `DEBUG`.
104-
- `json_encoder` *optional* — a class which is used to encode the props to JSON. Defaults
102+
- **json_encoder** *optional* — a class which is used to encode the props to JSON. Defaults
105103
to `django.core.serializers.json.DjangoJSONEncoder`.
106104

107105

0 commit comments

Comments
 (0)