Skip to content

docs: replace recorded gif with animated svg #473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed docs/assets/create-react-native-library.gif
Binary file not shown.
1 change: 1 addition & 0 deletions docs/assets/create-react-native-library.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/react-native-builder-bob.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 5 additions & 1 deletion docs/pages/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ To automatically configure your project to use `react-native-builder-bob`, open
npx react-native-builder-bob@latest init
```

This will ask you a few questions and add the required configuration and scripts for building the code. You can find details on what exactly it adds in the [Manual configuration](#manual-configuration) section.
This will ask you a few questions and add the required configuration and scripts for building the code. The code will be compiled automatically when the package is published.

You can find details on what exactly it adds in the [Manual configuration](#manual-configuration) section.

## Manual configuration

Expand Down Expand Up @@ -211,3 +213,5 @@ This builds the project according to the configuration. This is usually run as p
"prepare": "bob build"
}
```

![Demo](../assets/react-native-builder-bob.svg)
2 changes: 1 addition & 1 deletion docs/pages/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ npx create-react-native-library@latest awesome-library

This will ask you a few questions about your project and generate a new project in a folder named `awesome-library`.

![Demo](../assets/create-react-native-library.gif)
![Demo](../assets/create-react-native-library.svg)

After the project is created, you can find the development workflow in the generated `CONTRIBUTING.md` file.

Expand Down
3 changes: 2 additions & 1 deletion lefthook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ pre-commit:
run: npx tsc --noEmit
markdown:
glob: "*.md"
run: npx prettier --write {staged_files} && git add {staged_files}
run: npx prettier --write {staged_files}
stage_fixed: true
commit-msg:
parallel: true
commands:
Expand Down