Skip to content

Commit e232d5a

Browse files
authored
docs: replace recorded gif with animated svg (#473)
### Summary This reduces the file size, makes the recording sharp as well as makes the page look better in dark mode. The recording is done using https://asciinema.org/ and converted to svg with https://github.com/marionebl/svg-term-cli ### Test plan ![Kapture 2023-10-02 at 14 16 15](https://github.com/callstack/react-native-builder-bob/assets/1174278/3b007a09-1737-4881-93ae-f8adb6891fc4)
1 parent 4435abe commit e232d5a

File tree

6 files changed

+10
-3
lines changed

6 files changed

+10
-3
lines changed
-846 KB
Binary file not shown.

docs/assets/create-react-native-library.svg

Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading

docs/pages/build.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ To automatically configure your project to use `react-native-builder-bob`, open
2121
npx react-native-builder-bob@latest init
2222
```
2323

24-
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.
24+
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.
25+
26+
You can find details on what exactly it adds in the [Manual configuration](#manual-configuration) section.
2527

2628
## Manual configuration
2729

@@ -211,3 +213,5 @@ This builds the project according to the configuration. This is usually run as p
211213
"prepare": "bob build"
212214
}
213215
```
216+
217+
![Demo](../assets/react-native-builder-bob.svg)

docs/pages/create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ npx create-react-native-library@latest awesome-library
2525

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

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

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

lefthook.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ pre-commit:
99
run: npx tsc --noEmit
1010
markdown:
1111
glob: "*.md"
12-
run: npx prettier --write {staged_files} && git add {staged_files}
12+
run: npx prettier --write {staged_files}
13+
stage_fixed: true
1314
commit-msg:
1415
parallel: true
1516
commands:

0 commit comments

Comments
 (0)