All Projects → react-navigation → React Navigation.github.io

react-navigation / React Navigation.github.io

Licence: mit
Home of the documentation and other miscellanea

Programming Languages

javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to React Navigation.github.io

React Navigation
Routing and navigation for your React Native apps
Stars: ✭ 20,650 (+9875.85%)
Mutual labels:  hacktoberfest, navigation, react-navigation
Typescript Vs Flowtype
Differences between Flowtype and TypeScript -- syntax and usability
Stars: ✭ 1,671 (+707.25%)
Mutual labels:  hacktoberfest, documentation
Handbook
📖 Complete documentation for WP-CLI
Stars: ✭ 129 (-37.68%)
Mutual labels:  hacktoberfest, documentation
Hads
📚 Markdown superpowered documentation for Node.js
Stars: ✭ 147 (-28.99%)
Mutual labels:  hacktoberfest, documentation
Component Docs
📝 Simple documentation for your React components
Stars: ✭ 116 (-43.96%)
Mutual labels:  hacktoberfest, documentation
Docs
API Platform documentation
Stars: ✭ 119 (-42.51%)
Mutual labels:  hacktoberfest, documentation
Documentation
Stars: ✭ 133 (-35.75%)
Mutual labels:  hacktoberfest, documentation
Swagger Combine
Combines multiple Swagger schemas into one dereferenced schema.
Stars: ✭ 102 (-50.72%)
Mutual labels:  hacktoberfest, documentation
Home Assistant.io
📘 Home Assistant User documentation
Stars: ✭ 2,377 (+1048.31%)
Mutual labels:  hacktoberfest, documentation
Documentation
Pantheon Docs
Stars: ✭ 157 (-24.15%)
Mutual labels:  hacktoberfest, documentation
Sentry Docs
The new place for the sentry documentation (and tools to build it)
Stars: ✭ 160 (-22.71%)
Mutual labels:  hacktoberfest, documentation
React Styleguidist
Isolated React component development environment with a living style guide
Stars: ✭ 10,172 (+4814.01%)
Mutual labels:  hacktoberfest, documentation
Go Compression.github.io
The Hitchhiker's Guide to Compression
Stars: ✭ 106 (-48.79%)
Mutual labels:  hacktoberfest, documentation
Docs
📚 Documentation for 🚀 Fiber
Stars: ✭ 121 (-41.55%)
Mutual labels:  hacktoberfest, documentation
Docs
The source for https://www.gobuffalo.io
Stars: ✭ 105 (-49.28%)
Mutual labels:  hacktoberfest, documentation
Python Docs Es
Spanish translation of the Python documentation.
Stars: ✭ 131 (-36.71%)
Mutual labels:  hacktoberfest, documentation
React Native Navigation
A complete native navigation solution for React Native
Stars: ✭ 12,387 (+5884.06%)
Mutual labels:  hacktoberfest, navigation
Docs
Documentation for Tasmota (https://github.com/arendst/Tasmota)
Stars: ✭ 55 (-73.43%)
Mutual labels:  hacktoberfest, documentation
Re Navigate
Example of React Native Navigation with re-frame/re-natal
Stars: ✭ 61 (-70.53%)
Mutual labels:  navigation, react-navigation
Documentation
The source for Datadog's documentation site.
Stars: ✭ 147 (-28.99%)
Mutual labels:  hacktoberfest, documentation

Want to help improve the documentation? That would be so very much appreciated. Some information on that below.

Philosophy of documentation

  • Document the ugly parts as much as the good parts. It's better for users to know that we don't have a good solution to the problem they have and get the preferred workarounds from us than have to scour the dark and moist corners of StackOverflow.
  • Provide runnable examples where possible. Learning through interacting with the code is a reason why REPLs are so popular. Thanks to Snack we can provide the same kind of experience for React Navigation users too.
  • Be honest about the tradeoffs and limitations. We explain the pitch and anti-pitch of React Navigation and provide alternative libraries if React Navigation might not be a good fit. We should provide a similar level of honesty at finer levels of granularity as well.

Things anyone can do

Run it locally

  1. Clone the repository
  2. Run yarn
  3. yarn start

Make changes

  • Each documentation version of react-navigation is generated by the markdown files located in versioned_docs. Change them and refresh the page when running the documentation locally and you will see the changes reflected.
  • If you want to add a new page, you need to add it to the corresponding sidebars.json file and then restart the server.

Things you need to be a collaborator to do

Deployment is done automatically via Github Actions. Normally you shouldn't need to do these.

Download the latest translations

  • Configure CROWDIN_DOCUSAURUS_PROJECT_ID and CROWDIN_DOCUSAURUS_API_KEY environment variables (ask @brentvatne if you need access).
  • Run yarn crowdin-upload and then yarn crowdin-download

Update the sponsors list

  • Create a Github "Personal Access Token" here and set the read:org scope on it.
  • Set the environment variable REACT_NAV_GITHUB_TOKEN to that value.
  • Run yarn fetch-sponsors.
  • Commit the updated sponsors.js file.

Deploy it

Before deploying, be sure to download the latest translations!

Only collaborators on this repository can deploy. Run the following command from the main branch:

GIT_USER=<Your GitHub username> \
CURRENT_BRANCH=main \
USE_SSH=true \
yarn deploy

License

MIT License

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].