Skip to content

(Work in progress) React documentation website in Français

License

Notifications You must be signed in to change notification settings

Osedea/fr.reactjs.org

 
 

Repository files navigation

reactjs.org

This repo contains the source code and documentation powering reactjs.org in its French version.

Getting started

Prerequisites

  1. Git
  2. Node: any 8.x version starting with 8.4.0 or greater
  3. Yarn: See Yarn website for installation instructions
  4. A fork of the repo (for any contributions)
  5. A clone of the fr.reactjs.org repo on your local machine

Installation

  1. cd fr.reactjs.org to go into the project root
  2. yarn to install the website's npm dependencies

Running locally

  1. yarn dev to start the hot-reloading development server (powered by Gatsby)
  2. open http://localhost:8000 to open the site in your favorite browser

Contributing

Please, checkout issue #1 for specifics on contributing to the localization effort.

Guidelines

This repo is meant to provide French translation for the reactjs.org web site, changes should be limited to L10N features only (mostly string translation). To make deeper changes in the structure or the content of the web site, please consider contributing to the reactjs.org repo.

Create a branch

  1. git checkout master from any folder in your local reactjs.org repository
  2. git pull origin master to ensure you have the latest main code
  3. git checkout -b the-name-of-my-branch (replacing the-name-of-my-branch with a suitable name) to create a branch

Make the change

  1. Follow the "Running locally" instructions
  2. Save the files and check in the browser
  3. Changes to React components in src will hot-reload
  4. Changes to markdown files in content will hot-reload
  5. If working with plugins, you may need to remove the .cache directory and restart the server

Test the change

  1. If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.
  2. Run yarn check-all from the project root. (This will run Prettier, ESLint, and Flow.)

Push it

  1. git add -A && git commit -m "My message" (replacing My message with a commit message, such as Fixed header logo on Android) to stage and commit your changes
  2. git push my-fork-name the-name-of-my-branch
  3. Go to the fr.reactjs.org repo and you should see recently pushed branches.
  4. Follow GitHub's instructions.
  5. If possible, include screenshots of visual changes. A Netlify build will also be automatically created once you make your PR so other people can see your change.

Translation

If you are interested in translating reactjs.org, please see the current translation efforts at isreacttranslatedyet.com.

If your language does not have a translation and you would like to create one, please follow the instructions at reactjs.org Translations.

Troubleshooting

  • yarn reset to clear the local cache

License

Content submitted to fr.reactjs.org is CC-BY-4.0 licensed, as found in the LICENSE-DOCS.md file.

About

(Work in progress) React documentation website in Français

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 89.3%
  • CSS 10.0%
  • HTML 0.7%