Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# [reactnative.dev](https://reactnative.dev/) &middot; [![CC BY 4.0 license](https://img.shields.io/badge/license-CC%20BY%204.0-blue.svg)](LICENSE-docs) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md) <a href="https://twitter.com/intent/follow?screen_name=reactnative"><img src="https://img.shields.io/twitter/follow/reactnative.svg?label=Follow%20@reactnative" alt="Follow @reactnative" /></a>
# [reactnative.dev](https://reactnative.dev/) &middot; [![CC BY 4.0 license](https://img.shields.io/badge/license-CC%20BY%204.0-blue.svg)](LICENSE-docs) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md) <a href="https://twitter.com/intent/follow?screen_name=reactnative"><img src="https://img.shields.io/twitter/follow/reactnative.svg?label=Follow%20@reactnative" alt="Follow @reactnative on X" /></a> <a href="https://bsky.app/profile/reactnative.dev"><img src="https://img.shields.io/badge/Bluesky-0285FF?logo=bluesky&logoColor=fff" alt="Follow @reactnative.dev on Bluesky" /></a>

This repo contains the website configuration and documentation powering the [React Native website](https://reactnative.dev/).

If you are looking for the source code of the [React Native Archive website](https://archive.reactnative.dev/) select the [`archive`](https://github.com/facebook/react-native-website/tree/archive) branch.
> If you are looking for the source code of the [React Native Archive website](https://archive.reactnative.dev/) select the [`archive`](https://github.com/facebook/react-native-website/tree/archive) branch.

## Contents

Expand All @@ -17,21 +17,19 @@ If you are looking for the source code of the [React Native Archive website](htt
### Prerequisites

1. [Git](https://git-scm.com/downloads).
1. [Node](https://nodejs.org/en/download/) _(version 20 or greater)_.
1. [Node](https://nodejs.org/en/download/) _(version 22 or greater)_.
1. [Yarn](https://yarnpkg.com/getting-started/install) _(version 4)_.
1. A fork of the repo _(for any contributions)_.
1. A clone of the `react-native-website` repo.
1. A fork and clone of the `react-native-website` repo _(for any contributions)_.

### Installation

1. `cd react-native-website` to go into the project root.
1. Run `corepack enable` to enable Corepack.

> If the command above fails, run `npm install -g corepack@latest` to install the latest version of [Corepack](https://yarnpkg.com/corepack#installation).
> If the command above fails, run `npm install -g corepack@latest` to install the latest version of [Corepack](https://yarnpkg.com/corepack#installation).

1. Run `yarn` to install the website's workspace dependencies.

> If you want to retain the globally instaled `yarn` v1, you can use `corepack yarn` instead.
> If you want to retain the globally installed `yarn` classic, you can use `corepack yarn` instead.

### Running locally

Expand Down Expand Up @@ -112,7 +110,8 @@ If you're adding a new doc or you need to alter the order the docs appear in the

Part of the React Native website is versioned to allow users to go back and see the Guides or API reference documentation for any given release. A new version of the website is generally generated whenever there is a new React Native release. When this happens, any changes made to the `docs` and `website/sidebars.ts` files will be copied over to the corresponding location within `website/versioned_docs` and `website/versioned_sidebars`.

> **_Note:_** Do not edit the auto-generated files within `versioned_docs` or `versioned_sidebars` unless you are sure it is necessary. Edits made to older versions will not be propagated to newer versions of the versioned docs.
> [!NOTE]
> Do not edit the auto-generated files within `versioned_docs` or `versioned_sidebars` unless you are sure it is necessary. Edits made to older versions will not be propagated to newer versions of the versioned docs.

Docusaurus keeps track of the list of versions for the site in the `website/versions.json` file. The ordering of versions in this file should be in reverse chronological order.

Expand Down Expand Up @@ -150,7 +149,7 @@ The `showcase.json` file contains the list of users that are highlighted in the
1. `git checkout main` from any folder in your local `react-native-website` repository.
1. `git pull origin main` to ensure you have the latest main code.
1. `git checkout -b the-name-of-my-branch` to create a branch.
> replace `the-name-of-my-branch` with a suitable name, such as `update-animations-page`
> replace `the-name-of-my-branch` with a suitable name, such as `update-animations-page`

### Make the change

Expand All @@ -161,7 +160,11 @@ The `showcase.json` file contains the list of users that are highlighted in the

Visit **<http://localhost:3000/docs/next/YOUR-DOCS-PAGE>** to see your work.

> Visit <http://localhost:3000/versions> to see the list of all versions of the docs.
> [!NOTE]
> Visit <http://localhost:3000/versions> to see the list of all versions of the docs, if you have backported some of the changes.

> [!TIP]
> If you're adding assets, make sure they’re optimized for the web. You can use tools like [ImageOptim](https://imageoptim.com/mac) to automatically apply lossless compression to various file types.

### Test the change

Expand All @@ -175,7 +178,7 @@ If possible, test any visual changes in all latest versions of the following bro
1. Run `yarn prettier` and `yarn language:lint` in `./website` directory to ensure your changes are consistent with other files in the repo.
1. Run `yarn update-lock` to [deduplicate dependencies](https://yarnpkg.com/cli/dedupe).
1. `git add -A && git commit -m "My message"` to stage and commit your changes.
> replace `My message` with a commit message, such as `Fixed header logo on Android`
> replace `My message` with a commit message, such as `Fixed header logo on Android`
1. `git push my-fork-name the-name-of-my-branch`
1. Go to the [react-native-website repo](https://github.com/facebook/react-native-website) and you should see recently pushed branches.
1. Follow GitHub's instructions.
Expand Down
Binary file modified website/static/blog/assets/0.60-upgrade-helper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.62-flipper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.63-logbox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.66-artifact.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.66-build-npm-package.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.73-android-media-picker.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.73-debugging-docs.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.74-align-content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.74-android-app-size.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.74-row-reverse-after.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.74-row-reverse-before.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.74-static-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.75-android-gaps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.75-android-translations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.75-deprecation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.75-ios-gaps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.75-ios-translation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.75-rn-directory.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.76-boxshadow-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.76-bridge-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.76-directory.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.76-filter-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.76-react-native-devtools.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.77-blend-mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.77-border-box.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/blog/assets/0.77-display-contents-1.png
Binary file modified website/static/blog/assets/0.77-display-contents-2.gif
Binary file modified website/static/blog/assets/0.77-display-contents-3.gif
Binary file modified website/static/blog/assets/0.77-outline-props.png
Binary file modified website/static/blog/assets/0.77-swift-upgrade-helper.png
Binary file modified website/static/blog/assets/0.79-metro-startup-comparison.gif
Binary file modified website/static/blog/assets/0.80-android-apk-size.png
Binary file modified website/static/blog/assets/0.80-js-stable-api-appjs.jpg
Binary file modified website/static/blog/assets/0.80-legacy-arch-warnings.png
Binary file modified website/static/blog/assets/0.81-improved-uncaught-error.png
Binary file modified website/static/blog/assets/ElementInspecting.gif
Binary file modified website/static/blog/assets/FlexboxGapAfter.png
Binary file modified website/static/blog/assets/FlexboxGapBefore.png
Binary file modified website/static/blog/assets/blue-hero.jpg
Binary file modified website/static/blog/assets/build-com-blog-image.jpg
Binary file modified website/static/blog/assets/eli-at-f8.png
Binary file modified website/static/blog/assets/hermes-default-android-data.png
Binary file modified website/static/blog/assets/hermes-default-android-video.gif
Binary file modified website/static/blog/assets/hermes-default-ios-data.png
Binary file modified website/static/blog/assets/hermes-default-ios-slow-video.gif
Binary file modified website/static/blog/assets/hermes-default-ios-video.gif
Binary file modified website/static/blog/assets/input-accessory-1.png
Binary file modified website/static/blog/assets/ios-15-navigation-bar.jpg
Binary file modified website/static/blog/assets/ios-15-quicktype-bar.png
Binary file modified website/static/blog/assets/loading-screen-04.png
Binary file modified website/static/blog/assets/many-platform-vision-oculus-home.png
Binary file modified website/static/blog/assets/package-exports-rollout.png
Binary file modified website/static/blog/assets/pointer-events-code-flow.png
Binary file modified website/static/blog/assets/pointer-events-wpt-demo.gif
Binary file modified website/static/blog/assets/rnmsf-august-2016-airbnb.jpg
Binary file modified website/static/blog/assets/rnmsf-august-2016-docs.jpg
Binary file modified website/static/blog/assets/rnmsf-august-2016-netflix.jpg
Binary file modified website/static/blog/assets/rtl-ama-android-hebrew.png
Binary file modified website/static/blog/assets/rtl-ama-ios-arabic.png
Binary file modified website/static/blog/assets/rtl-demo-swipe-ltr.png
Binary file modified website/static/blog/assets/typescript-first-new-app.png
Binary file modified website/static/docs/assets/AddFilesToXcode1.png
Binary file modified website/static/docs/assets/AddFilesToXcode2.png
Binary file modified website/static/docs/assets/AddToSearchPaths.png
Binary file modified website/static/docs/assets/AddWebKitFramework1.png
Binary file modified website/static/docs/assets/AddWebKitFramework2.png
Binary file modified website/static/docs/assets/Architecture/renderer-phase-one.png
Binary file modified website/static/docs/assets/Architecture/renderer-phase-two.png
Binary file modified website/static/docs/assets/BridgingHeader.png
Binary file modified website/static/docs/assets/CallStackDemo.jpg
Binary file modified website/static/docs/assets/CxxGuideAndroidVideo.gif
Binary file modified website/static/docs/assets/CxxGuideIOSVideo.gif
Binary file modified website/static/docs/assets/CxxTMGuideXcodeProject.png
Binary file modified website/static/docs/assets/DevMenu.png
Binary file modified website/static/docs/assets/EmbeddedAppAndroidFragmentVideo.gif
Binary file modified website/static/docs/assets/EmbeddedAppAndroidVideo.gif
Binary file modified website/static/docs/assets/EmbeddedAppIOSVideo.gif
Binary file modified website/static/docs/assets/EmbeddedAppiOS078.gif
Binary file modified website/static/docs/assets/GettingStartedAVDManagerMacOS.png
Binary file modified website/static/docs/assets/GettingStartedAndroidSuccessWindows.png
Binary file modified website/static/docs/assets/GettingStartedCongratulations.png
Binary file modified website/static/docs/assets/HermesProfileSaved.png
Binary file modified website/static/docs/assets/ObjectObserveError.png
Binary file modified website/static/docs/assets/RNTesterPlayground.png
Binary file modified website/static/docs/assets/ReactDevToolsConnection.gif
Binary file modified website/static/docs/assets/ReactDevToolsInspector.gif
Binary file modified website/static/docs/assets/XCodeEnableATS.png
Binary file modified website/static/docs/assets/brownfield-with-initial-props.png
2 changes: 1 addition & 1 deletion website/static/docs/assets/d_pressable_anatomy.svg
Loading