Skip to content

Commit f89c983

Browse files
authored
Update README.md
1 parent 2d07086 commit f89c983

1 file changed

Lines changed: 4 additions & 6 deletions

File tree

react/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# React (Experimental)
22

3-
The files in this directory are react components that can be then be used within markdown files by adding `interactive: true` frontmatter to a markdown file and then using the following syntax to embed the component:
3+
The files in this directory are React components. We can use these components within Markdown files by adding `interactive: true` frontmatter to a Markdown file. Then, using the following syntax to embed the component:
44

55
```
66
<!--react-->
@@ -12,13 +12,12 @@ Theoretically React can be embedded anywhere on the site with a little bit of cr
1212

1313
## Defining new components
1414

15-
16-
Start by adding frontmatter `interactive:true` to any markdown file that you want to support react (this prevents react render time from slowing down any other page and keeping the impact on performance very low)
15+
Start by adding frontmatter `interactive:true` to any Markdown file that you want to support React. This prevents React render time from slowing down any other page and keeping the impact on performance very low.
1716

1817
1. Create the component in the `./react` directory
1918
2. Register the component for webpack in `./javascripts/index.js` so the component works with client side rendering
2019
3. Register the component in `./lib/react-engine.js` so the component works with server side rendering
21-
4. If the component needs to be evaluated client side, see [this example](https://github.com/github/docs/blob/a48998c7890b71c8f58eda1fa31b50df348a0042/react/CodeEditor.js) for how to ensure the client side component rendered by the server gets [Hyrdated](https://reactjs.org/docs/react-dom.html#hydrate).
20+
4. If the component needs to be evaluated client side, see [this example](https://github.com/github/docs/blob/a48998c7890b71c8f58eda1fa31b50df348a0042/react/CodeEditor.js) for how to ensure the client side component rendered by the server gets [Hydrated](https://reactjs.org/docs/react-dom.html#hydrate).
2221

2322
## A Complete Example
2423

@@ -31,10 +30,9 @@ The following example demonstrates the addition of an interactive CodeEditor on
3130
- [Enabling React components on a page](https://github.com/github/docs/blame/a48998c7890b71c8f58eda1fa31b50df348a0042/content/github/getting-started-with-github/access-permissions-on-github.md#L12)
3231
- [Adding the CodeEditor to a page](https://github.com/github/docs/blame/a48998c7890b71c8f58eda1fa31b50df348a0042/content/github/getting-started-with-github/access-permissions-on-github.md#L47)
3332

34-
3533
## Gotchas
3634

37-
- When requiring react components from npm you will often need to explicitly call require('component').default to make sure you get the component
35+
- When requiring React components from npm you will often need to explicitly call `require('component').default` to make sure you get the component
3836
- Some code examples you get from external React packages won't work out of the box, you often need to dig into the module and determine whether it's exporting to default or not which will in many cases cause you to need to `require('package').default`
3937
- `import` doesn't always work. Use `require` for a more consistent experience with React in this codebase.
4038
- If components require you to load CSS, you need to load that CSS in the `javascripts/index.js` file as shown [here](https://github.com/github/docs/blob/a48998c7890b71c8f58eda1fa31b50df348a0042/javascripts/index.js#L22)

0 commit comments

Comments
 (0)