Skip to content

Commit 455d2d1

Browse files
Kevin Lackergaearon
Kevin Lacker
authored and
gaearon
committed
New Documentation
1 parent 8cac523 commit 455d2d1

File tree

355 files changed

+7520
-27325
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

355 files changed

+7520
-27325
lines changed

‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ docs/code
1515
docs/_site
1616
docs/.sass-cache
1717
docs/js/*
18-
docs/downloads
18+
docs/downloads/*.zip
1919
docs/vendor/bundle
2020
examples/shared/*.js
2121
examples/**/bundle.js

‎docs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ $ cd react/docs
3838
$ bundle exec rake
3939
$ bundle exec rake fetch_remotes
4040
$ bundle exec jekyll serve -w
41-
$ open http://localhost:4000/react/
41+
$ open http://localhost:4000/react/index.html
4242
```
4343

4444
We use [SASS](http://sass-lang.com/) (with [Bourbon](http://bourbon.io/)) for our CSS, and we use JSX to transform some of our JS.

‎docs/_config.yml

+10-3
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,29 @@ defaults:
2020
type: pages
2121
values:
2222
sectionid: blog
23+
- scope:
24+
path: tutorial
25+
type: pages
26+
values:
27+
layout: tutorial
28+
sectionid: tutorial
2329
- scope:
2430
path: docs
2531
type: pages
2632
values:
2733
layout: docs
2834
sectionid: docs
2935
- scope:
30-
path: tips
36+
path: contributing
3137
type: pages
3238
values:
3339
sectionid: docs
3440
- scope:
35-
path: contributing
41+
path: community
3642
type: pages
3743
values:
38-
sectionid: docs
44+
layout: community
45+
sectionid: community
3946
exclude:
4047
- Gemfile
4148
- Gemfile.lock

‎docs/_data/nav_community.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
- title: Community Resources
2+
items:
3+
- id: support
4+
title: Where To Get Support
5+
- id: conferences
6+
title: Conferences
7+
- id: videos
8+
title: Videos
9+
- id: complementary-tools
10+
title: Complementary Tools
11+
href: https://github.com/facebook/react/wiki/Complementary-Tools
12+
- id: examples
13+
title: Examples
14+
href: https://github.com/facebook/react/wiki/Examples

‎docs/_data/nav_docs.yml

+77-98
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,83 @@
11
- title: Quick Start
22
items:
3-
- id: getting-started
4-
title: Getting Started
5-
- id: tutorial
6-
title: Tutorial
7-
- id: thinking-in-react
8-
title: Thinking in React
9-
- title: Community Resources
3+
- id: installation
4+
title: Installation
5+
- id: hello-world
6+
title: Hello World
7+
- id: introducing-jsx
8+
title: Introducing JSX
9+
- id: rendering-elements
10+
title: Rendering Elements
11+
- id: components-and-props
12+
title: Components and Props
13+
- id: state-and-lifecycle
14+
title: State and Lifecycle
15+
- id: handling-events
16+
title: Handling Events
17+
- id: conditional-rendering
18+
title: Conditional Rendering
19+
- id: lists-and-keys
20+
title: Lists and Keys
21+
- id: forms
22+
title: Forms
23+
- id: lifting-state-up
24+
title: Lifting State Up
25+
- id: composition-vs-inheritance
26+
title: Composition vs Inheritance
27+
- id: thinking-in-react
28+
title: Thinking In React
29+
- title: Advanced Guides
1030
items:
11-
- id: conferences
12-
title: Conferences
13-
- id: videos
14-
title: Videos
15-
- id: complementary-tools
16-
title: Complementary Tools
17-
href: https://github.com/facebook/react/wiki/Complementary-Tools
18-
- id: examples
19-
title: Examples
20-
href: https://github.com/facebook/react/wiki/Examples
21-
- title: Guides
22-
items:
23-
- id: why-react
24-
title: Why React?
25-
- id: displaying-data
26-
title: Displaying Data
27-
subitems:
2831
- id: jsx-in-depth
29-
title: JSX in Depth
30-
- id: jsx-spread
31-
title: JSX Spread Attributes
32-
- id: jsx-gotchas
33-
title: JSX Gotchas
34-
- id: interactivity-and-dynamic-uis
35-
title: Interactivity and Dynamic UIs
36-
- id: multiple-components
37-
title: Multiple Components
38-
- id: reusable-components
39-
title: Reusable Components
40-
- id: transferring-props
41-
title: Transferring Props
42-
- id: forms
43-
title: Forms
44-
- id: working-with-the-browser
45-
title: Working With the Browser
46-
subitems:
47-
- id: more-about-refs
48-
title: Refs to Components
49-
- id: tooling-integration
50-
title: Tooling Integration
51-
subitems:
52-
- id: language-tooling
53-
title: Language Tooling
54-
- id: package-management
55-
title: Package Management
56-
- id: environments
57-
title: Server-side Environments
58-
- id: addons
59-
title: Add-Ons
60-
subitems:
61-
- id: animation
62-
title: Animation
63-
- id: two-way-binding-helpers
64-
title: Two-Way Binding Helpers
65-
- id: test-utils
66-
title: Test Utilities
67-
- id: clone-with-props
68-
title: Cloning Elements
69-
- id: create-fragment
70-
title: Keyed Fragments
71-
- id: update
72-
title: Immutability Helpers
73-
- id: pure-render-mixin
74-
title: PureRenderMixin
75-
- id: perf
76-
title: Performance Tools
77-
- id: shallow-compare
78-
title: Shallow Compare
79-
- id: advanced-performance
80-
title: Advanced Performance
81-
- id: context
82-
title: Context
32+
title: JSX In Depth
33+
- id: typechecking-with-proptypes
34+
title: Typechecking With PropTypes
35+
- id: refs-and-the-dom
36+
title: Refs and the DOM
37+
- id: optimizing-performance
38+
title: Optimizing Performance
39+
- id: react-without-es6
40+
title: React Without ES6
41+
- id: react-without-jsx
42+
title: React Without JSX
43+
- id: reconciliation
44+
title: Reconciliation
45+
- id: context
46+
title: Context
47+
- id: web-components
48+
title: Web Components
8349
- title: Reference
8450
items:
85-
- id: top-level-api
86-
title: Top-Level API
87-
- id: component-api
88-
title: Component API
89-
- id: component-specs
90-
title: Component Specs and Lifecycle
91-
- id: tags-and-attributes
92-
title: Supported Tags and Attributes
93-
- id: events
94-
title: Event System
95-
- id: dom-differences
96-
title: DOM Differences
97-
- id: special-non-dom-attributes
98-
title: Special Non-DOM Attributes
99-
- id: reconciliation
100-
title: Reconciliation
101-
- id: webcomponents
102-
title: Web Components
103-
- id: glossary
104-
title: React (Virtual) DOM Terminology
51+
- id: react-api
52+
title: React
53+
subitems:
54+
- id: react-component
55+
title: React.Component
56+
- id: react-dom
57+
title: ReactDOM
58+
- id: react-dom-server
59+
title: ReactDOMServer
60+
- id: dom-elements
61+
title: DOM Elements
62+
- id: events
63+
title: SyntheticEvent
64+
- id: addons
65+
title: Add-Ons
66+
subitems:
67+
- id: perf
68+
title: Performance Tools
69+
- id: test-utils
70+
title: Test Utilities
71+
- id: animation
72+
title: Animation
73+
- id: create-fragment
74+
title: Keyed Fragments
75+
- id: update
76+
title: Immutability Helpers
77+
- id: pure-render-mixin
78+
title: PureRenderMixin
79+
- id: shallow-compare
80+
title: Shallow Compare
81+
- id: two-way-binding-helpers
82+
title: Two-way Binding Helpers
83+

‎docs/_data/nav_tips.yml

-38
This file was deleted.

‎docs/_data/nav_tutorial.yml

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
- title: Tutorial
2+
items:
3+
- id: tutorial
4+
title: Overview
5+
subitems:
6+
- id: what-were-building
7+
title: What We're Building
8+
href: /react/tutorial/tutorial.html#what-were-building
9+
forceInternal: true
10+
- id: what-is-react
11+
title: What is React?
12+
href: /react/tutorial/tutorial.html#what-is-react
13+
forceInternal: true
14+
- id: getting-started
15+
title: Getting Started
16+
href: /react/tutorial/tutorial.html#getting-started
17+
forceInternal: true
18+
- id: passing-data-through-props
19+
title: Passing Data Through Props
20+
href: /react/tutorial/tutorial.html#passing-data-through-props
21+
forceInternal: true
22+
- id: an-interactive-component
23+
title: An Interactive Component
24+
href: /react/tutorial/tutorial.html#an-interactive-component
25+
forceInternal: true
26+
- id: developer-tools
27+
title: Developer Tools
28+
href: /react/tutorial/tutorial.html#developer-tools
29+
forceInternal: true
30+
- id: lifting-state-up
31+
title: Lifting State Up
32+
href: /react/tutorial/tutorial.html#lifting-state-up
33+
forceInternal: true
34+
subitems:
35+
- id: why-immutability-is-important
36+
title: Why Immutability Is Important
37+
href: /react/tutorial/tutorial.html#why-immutability-is-important
38+
forceInternal: true
39+
- id: functional-components
40+
title: Functional Components
41+
href: /react/tutorial/tutorial.html#functional-components
42+
forceInternal: true
43+
- id: taking-turns
44+
title: Taking Turns
45+
href: /react/tutorial/tutorial.html#taking-turns
46+
forceInternal: true
47+
- id: declaring-a-winner
48+
title: Declaring a Winner
49+
href: /react/tutorial/tutorial.html#declaring-a-winner
50+
forceInternal: true
51+
- id: storing-a-history
52+
title: Storing A History
53+
href: /react/tutorial/tutorial.html#storing-a-history
54+
forceInternal: true
55+
subitems:
56+
- id: showing-the-moves
57+
title: Showing the Moves
58+
href: /react/tutorial/tutorial.html#showing-the-moves
59+
forceInternal: true
60+
- id: keys
61+
title: Keys
62+
href: /react/tutorial/tutorial.html#keys
63+
forceInternal: true
64+
- id: implementing-time-travel
65+
title: Implementing Time Travel
66+
href: /react/tutorial/tutorial.html#implementing-time-travel
67+
forceInternal: true
68+
- id: wrapping-up
69+
title: Wrapping Up
70+
href: /react/tutorial/tutorial.html#wrapping-up
71+
forceInternal: true

0 commit comments

Comments
 (0)