Skip to content
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

docs: describe using a custom URL with create-turbo. #9507

Merged
merged 1 commit into from
Nov 24, 2024
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
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
Loading