1# Expo Documentation 2 3This is the public documentation for **Expo**, its SDK, client and services. 4 5You can access this documentation online at https://docs.expo.io/. It's built using next.js on top of the https://github.com/zeit/docs codebase. 6 7> **Contributors:** Please make sure that you edit the docs in the `pages/versions/unversioned` directory if you want your changes to apply to the next SDK version too! 8 9### Running Locally 10 11Download the copy of this repository. 12 13```sh 14git clone https://github.com/expo/expo.git 15``` 16 17Then `cd` into the `docs` directory and install dependencies with: 18 19```sh 20yarn 21``` 22 23Then you can run the app with (make sure you have no server running on port `3000`): 24 25```sh 26yarn run dev 27``` 28 29Now the documentation is running at http://localhost:3000 30 31### Running in production mode 32 33```sh 34yarn run export 35yarn run export-server 36``` 37 38### Editing Docs Content 39 40You can find the source of the documentation inside the `pages/versions` directory. Documentation is mostly written in markdown with the help of some React components (for Snack embeds, etc). The routes and navbar are automatically inferred from the directory structure within `versions`. 41 42### Redirects 43 44Server-side redirects are re-created on each run of `deploy.sh`. See that file for 45 46We currently do two client-side redirects, using meta tags with `http-equiv="refresh"`: 47 48- `/` -> `/versions/latest/` 49- `/versions` -> `/versions/latest` 50 51This method is not great for accessibility and should be avoided where possible. 52 53### Adding Images and Assets 54 55You can add images and assets to the `static` directory. They'll be served by the production and staging servers at `/static`. 56 57### New Components 58 59Always try to use the existing components and features in markdown. Create a new component or use a component from NPM, unless there is no other option. 60 61### Quirks 62 63* You can't have curly brace without quotes: \`{}\` -> `{}` 64* Make sure to leave a empty newline between a table and following content 65 66## A note about versioning 67 68Expo's SDK is versioned so that apps made on old SDKs are still supported 69when new SDKs are relased. The website documents previous SDK versions too. 70 71Version names correspond to directory names under `versions`. 72 73`unversioned` is a special version for the next SDK release. It is not included in production output 74 75`latest` is an untracked folder which duplicates the contents of the folder matching the version number in `package.json`. 76 77Sometimes you want to make an edit in version `X` and have that edit also 78be applied in versions `Y, Z, ...` (say, when you're fixing documentation for an 79API call that existed in old versions too). You can use the 80`./scripts/versionpatch.sh` utility to apply your `git diff` in one version in 81other versions. For example, to update the docs in `unversioned` then apply it 82on `v8.0.0` and `v7.0.0`, you'd do the following after editing the docs in 83`unversioned` such that it shows up in `git diff`: 84 85`./scripts/versionpatch.sh unversioned v8.0.0 v7.0.0` 86 87Any changes in your `git diff` outside the `unversioned` directory are ignored 88so don't worry if you have code changes or such elsewhere. 89 90### Updating latest version of docs 91 92When we release a new SDK, we copy the `unversioned` directory, and rename it to the new version. Latest version of docs is read from `package.json` so make sure to update the `version` key there as well. However, if you update the `version` key there, you need to `rm -rf node_modules/.cache/` before the change is picked up (why? [read this](https://github.com/zeit/next.js/blob/4.0.0/examples/with-universal-configuration/README.md#caveats)). 93 94Make sure to also grab the upgrade instructions from the release notes blog post and put them in `upgrading-expo-sdk-walkthrough.md`. 95 96That's all you need to do. The `versions` directory is listed on server start to find all available versions. The routes and navbar contents are automatically inferred from the directory structure within `versions`. 97 98Because the navbar is automatically generated from the directory structure, the default ordering of the links under each section is alphabetical. However, for many sections, this is not ideal UX. So, if you wish to override the alphabetical ordering, manipulate page titles in `sidebar-navigation-order.js`. 99 100#### Importing from the React Native docs 101 102You can import the React Native docs in an automated way into these docs. 103 1041. Update the react-native-website submodule here 1052. `yarn run import-react-native-docs` 106 107This will write all the relevant RN doc stuff into the unversioned version directory. 108You may need to tweak the script as the source docs change; the script hackily translates between the different forms of markdown that have different quirks. 109 110The React Native docs are actually versioned but we currently read off of master. 111 112TODOs: 113 - Handle image sizing in imports better 114 - Read from the appropriate version (configurable) of the React Native docs, not just master 115 - Make Snack embeds work; these are marked in some of the React Native docs but they are just imported as plain JS code blocks 116