Skip to content

Commit

Permalink
Merge pull request #406 from schalkneethling/add-local-testing-docs
Browse files Browse the repository at this point in the history
fix(docs): run Bob inside interactive examples locally
  • Loading branch information
Schalk Neethling authored Jan 16, 2020
2 parents b32e11a + df01e98 commit 14aea4a
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,11 @@ This project uses Commitizen to ensure all pull requests follow the same format,

To use this flow, add files as you normally would with `git add .`, and when you are ready to commit, simply type `git commit` and follow the prompts.
You can [read more on the Conventional Changelog format](https://github.com/conventional-changelog/conventional-changelog) on its repository.

## Testing Bob locally inside Interactive Examples

Bob is used to build the interactive-example pages and is installed as a dependency inside the [interactive-examples repo](https://github.com/mdn/interactive-examples/). When working on changes to Bob, there is often a need to test the changes by running Bob inside the interactive-examples repo locally. To do this, use the following command:

```
npx install-local ~/path/to/repo/bob && node node_modules/.bin/mdn-bob
```

0 comments on commit 14aea4a

Please sign in to comment.