diff --git a/docs/repo-docs/getting-started/installation.mdx b/docs/repo-docs/getting-started/installation.mdx index cb20b1eb51756..0af48b078e0d5 100644 --- a/docs/repo-docs/getting-started/installation.mdx +++ b/docs/repo-docs/getting-started/installation.mdx @@ -128,21 +128,37 @@ The community curates a set of examples to showcase ways to use common tools and ```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] + +```` ```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] +```` ```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] + ``` @@ -152,3 +168,4 @@ pnpm dlx create-turbo@latest --example [example-name] Use any of the example's names below: +``` diff --git a/docs/repo-docs/reference/create-turbo.mdx b/docs/repo-docs/reference/create-turbo.mdx index 48d1a7d542acd..4fa742a1aefa1 100644 --- a/docs/repo-docs/reference/create-turbo.mdx +++ b/docs/repo-docs/reference/create-turbo.mdx @@ -59,6 +59,34 @@ Use any of the example's names below: +### 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. + + + +```bash title="Terminal" +npx create-turbo@latest --example [github-url] +``` + + + + +```bash title="Terminal" +yarn dlx create-turbo@latest --example [github-url] +``` + + + + +```bash title="Terminal" +pnpm dlx create-turbo@latest --example [github-url] +``` + + + + + ## Options ```txt title="Terminal"