Skip to content

Commit

Permalink
docs: describe using a custom URL with create-turbo.
Browse files Browse the repository at this point in the history
  • Loading branch information
anthonyshew committed Nov 24, 2024
1 parent 832fa25 commit 2e8ae60
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 2 deletions.
21 changes: 19 additions & 2 deletions docs/repo-docs/getting-started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -128,21 +128,37 @@ The community curates a set of examples to showcase ways to use common tools and
<PackageManagerTabs>
<Tab>
```bash title="Terminal"
# Use an example listed below
npx create-turbo@latest --example [example-name]
```

# Use a GitHub repository from the community

npx create-turbo@latest --example [github-url]

````

</Tab>

<Tab>
```bash title="Terminal"
# Use an example listed below
yarn dlx create-turbo@latest --example [example-name]
```
# Use a GitHub repository from the community
yarn dlx create-turbo@latest --example [github-url]
````
</Tab>
<Tab>
```bash title="Terminal"
# Use an example listed below
pnpm dlx create-turbo@latest --example [example-name]

# Use a GitHub repository from the community

pnpm dlx create-turbo@latest --example [github-url]

```

</Tab>
Expand All @@ -152,3 +168,4 @@ pnpm dlx create-turbo@latest --example [example-name]
Use any of the example's names below:

<ExamplesTable />
```
28 changes: 28 additions & 0 deletions docs/repo-docs/reference/create-turbo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,34 @@ Use any of the example's names below:

<ExamplesTable />

### Use a community example

You can also use a custom starter or example by using a GitHub URL. This is useful for using your own custom starters or examples from the community.

<PackageManagerTabs>
<Tab>
```bash title="Terminal"
npx create-turbo@latest --example [github-url]
```

</Tab>

<Tab>
```bash title="Terminal"
yarn dlx create-turbo@latest --example [github-url]
```

</Tab>

<Tab>
```bash title="Terminal"
pnpm dlx create-turbo@latest --example [github-url]
```

</Tab>

</PackageManagerTabs>

## Options

```txt title="Terminal"
Expand Down

0 comments on commit 2e8ae60

Please sign in to comment.