Overview
The React Native website is a static site generated using Docusaurus, containing documentation and website configuration. Contributors can edit and contribute to the docs, website architecture, and website configuration to enhance the React Native website. The website structure consists of markdown files found in various directories.
Features
- Markdown-based content generation
- Integration with Docusaurus for static site generation
- Versioned documentation for different releases
- Easy customization of sidebar and documentation order
- Prerequisites and steps clearly outlined for contribution
- License under CC BY 4.0
- Circle CI status integration for continuous integration
- Local server setup for testing changes
Installation
- Clone the
react-native-website
repository. - Navigate to the project root using
cd react-native-website
. - Install dependencies by running
yarn
. - To run the website locally:
- Move to the website directory with
cd website
. - Start the development server using
yarn start
. - Visit http://localhost:3000/ in your browser.
- Move to the website directory with
Summary
The React Native website offers a platform for contributors to enhance and maintain the documentation using markdown files. With the integration of Docusaurus, the website showcases versioned documentation and provides easy customization options for content organization. By following the provided installation guide, contributors can efficiently set up a local environment to test their changes before contributing to the website.