facebook / react-native-website

reactnative.dev This repo contains the website configuration and documentation powering the React Native website. > If you are looking for the source code of the React Native Archive website select the branch. Contents • Getting started • Overview • Website configuration • Contributing • License ✈️ Getting started Prerequisites • Git. • Node _(version 22 or greater)_. • Yarn _(version 4)_. • A fork and clone of the repo _(for any contributions)_. Installation • to go into the project root. • Run to enable Corepack. > If the command above fails, run to install the latest version of Corepack. • Run to install the website's workspace dependencies. > If you want to retain the globally installed classic, you can use instead. Running locally • Run to start the development server _(powered by Docusaurus)_. • Open site in your favorite browser. 📖 Overview If you would like to **_contribute an edit or addition to the docs,_** read through our style guide before you write anything. Almost all our content is generated from markdown files you can find in the , and directories. **_To edit the internals of how the site is built,_** you may want to get familiarized with how the site is built. The React Native website is a static site generated using Docusaurus. The website configuration can be found in the directory. Visit the Docusaurus website to learn more about all the available configuration options. Directory Structure The following is a high-level overview of relevant files and folders. Documentation sources As mentioned above, the folder contains the source files for docs from "Guides", "Components" and "APIs" tabs on the React Native website (versioned docs). The doc files for the "Architecture" and "Contribution" tabs are located inside in the respective directories (unversioned/static docs). In most cases, you will only want to edit the files within those directories. If you're adding a new doc or you need to alter the order the docs appear in the sidebar, take a look at the , and files in the directory. The sidebar files contain a list of document ids that should match those defined in the header metadata (aka frontmatter) of the docs markdown files. Versioned docs 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 and files will be copied over to the corresponding location within and . > [!NOTE] > Do not edit the auto-generated files within or 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 file. The ordering of versions in this file should be in reverse chronological order. Cutting a new version After RC The React Native website lints and typechecks documents in "next". The version of React Native used by the linter should be updated before a release for consistency and to catch any documents/examples where APIs have changed. This can be done by updating the and configuration files in the same way a React Native application would be updated. The diff of these files can be seen using a tool like React Native Upgrade Helper. After Release • to go into the project root. • to go into the website portion of the project. • Run where is the new version being released (e.g. ). • Open a PR and commit this change as "Cut branch " 🔧 Website configuration The main config file for the website can be found at . This file tells Docusaurus how to build the website. Edits to this file are rarely necessary. The subdirectory contains JavaScript and React components that are the core part of the website. The subdirectory contains the React components that make up the non-documentation pages of the site, such as the homepage. The subdirectory contains the swizzled React components from the Docusaurus theme. The file contains the list of users that are highlighted in the React Native showcase. 👏 Contributing Create a branch • from any folder in your local repository. • to ensure you have the latest main code. • to create a branch. > replace with a suitable name, such as Make the change • Follow the "Running locally" instructions. • Save the files and check in the browser. • Some changes may require a server restart to generate new files. (Pages in always do!) • Edits to pages in will only be visible in the latest version of the documentation, called "Next", located under the path. Visit ** ** to see your work. > [!NOTE] > Visit 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 to automatically apply lossless compression to various file types. Test the change If possible, test any visual changes in all latest versions of the following browsers: • Chrome and Firefox on the desktop. • Chrome and Safari on mobile. Push it • Run and in directory to ensure your changes are consistent with other files in the repo. • Run to deduplicate dependencies. • to stage and commit your changes. > replace with a commit message, such as • • Go to the react-native-website repo and you should see recently pushed branches. • Follow GitHub's instructions. • Describe briefly your changes (in case of visual changes, please include screenshots). 📄 License React Native is MIT licensed. React Native documentation is Creative Commons licensed.