Skip to content

Commit

Permalink
Merge pull request #21422 from Expensify/marco-updateDocumentationHel…
Browse files Browse the repository at this point in the history
…pSite

[No QA] Update documentation to build the help site locally
  • Loading branch information
arosiclair authored Jun 26, 2023
2 parents ae8a751 + 2627b01 commit f867c17
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ ln -sf universal-darwin22 universal-darwin21
## Steps

1. Open the Terminal command line in macOS.
1. In the root folder of the repository, execute `npm run createDocsRoutes` to generate the file which contains the routes for the articles (without this, the site will appear empty).
1. Navigate to the `docs` folder in the command line.
1. Run `bundle exec jekyll serve --livereload`.
- _Note: If you see an error like `Unable to load the EventMachine C Extension...`, try running `gem uninstall eventmachine && bundle install`. If that doesn't work just removing the `--livereload` flag should work._
Expand All @@ -46,7 +47,7 @@ ln -sf universal-darwin22 universal-darwin21
### Android Chrome emulator
To visit the site on the Android emulator, go to `10.0.2.2:4000`.

If you're getting an error page that says "Refused to connect", try running `adb reverse tcp:4000 tcp:4000` with your emulator open.
If you're getting an error page that says "Refused to connect", try running `adb reverse tcp:4000 tcp:4000` with your emulator open.


# How the project is structured
Expand Down

0 comments on commit f867c17

Please sign in to comment.