Skip to content

Commit ceb8375

Browse files
committed
docs: add template as an option to get started
1 parent cd9b310 commit ceb8375

File tree

3 files changed

+22
-5
lines changed

3 files changed

+22
-5
lines changed

apps/astro-docs/src/content/docs/core/getting-started/installation.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,24 @@ description: Install Angular Three and its dependencies.
66
import { Tabs, TabItem } from '@astrojs/starlight/components';
77

88
<Tabs>
9+
<TabItem label="Using template repository">
10+
The easiest way to get started with Angular Three is to use the [template repository](https://github.com/angular-threejs/template)
11+
12+
The template repository is kept up to date with the latest version of Angular Three.
13+
14+
:::tip[Did you know?]
15+
16+
If you have the [Github CLI](https://cli.github.com/) installed, you can use the `gh repo create` command to clone the template repository directly from the command line.
17+
18+
```shell
19+
gh repo create <username>/<repository-name>
20+
--template angular-threejs/template
21+
--public
22+
--clone
23+
```
24+
25+
:::
26+
</TabItem>
927
<TabItem label="Angular CLI">
1028
Angular Three provides an `ng-add` schematic to set up `angular-three` and its dependencies.
1129

@@ -55,4 +73,5 @@ import { Tabs, TabItem } from '@astrojs/starlight/components';
5573
}
5674
```
5775
</TabItem>
76+
5877
</Tabs>

apps/astro-docs/src/content/docs/core/testing/fire-event.mdx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,10 @@ description: Details about the Angular Three Testing `fireEvent` method
1414
- `eventData` is an optional object that contains the event data
1515

1616
```ts
17-
const { fixture, fireEvent } = NgtTestBed.create(SceneGraph);
17+
const { fireEvent } = NgtTestBed.create(SceneGraph);
1818

1919
await fireEvent(mesh, 'click');
20-
fixture.detectChanges();
21-
2220
await fireEvent(mesh, 'pointerover');
23-
fixture.detectChanges();
2421
```
2522

2623
#### `fireEvent.setAutoDetectChanges(auto: boolean)`

apps/astro-docs/src/content/docs/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,14 @@ Angular Three consists of the following packages:
3737
- `angular-three`: The main package that provides a custom renderer for Angular.
3838
- `angular-three-soba`: A collection of utilities and abstractions for building 3D applications with Angular Three.
3939
- `angular-three-postprocessing`: A collection of post-processing effects for Angular Three.
40+
- `angular-three-rapier`: Rapier.js integration for Angular Three.
4041
- `angular-three-cannon`: Cannon.js integration for Angular Three.
4142

4243
#### Compatibility Matrix
4344

4445
| Angular Three Version | THREE.js Version | Angular Version | ngxtension Version |
4546
| --------------------- | ---------------- | --------------- | ------------------ |
46-
| 2.0.0 | >= 0.148 | >= 18.0.0 | >= 3.0.0 |
47+
| ^2.0.0 | >= 0.148 | >= 18.0.0 | >= 3.0.0 |
4748

4849
## Acknowledgements
4950

0 commit comments

Comments
 (0)