diff --git a/website/docs/i18n/i18n-crowdin.mdx b/website/docs/i18n/i18n-crowdin.mdx index 953372107d..b6b2fa31a5 100644 --- a/website/docs/i18n/i18n-crowdin.mdx +++ b/website/docs/i18n/i18n-crowdin.mdx @@ -52,7 +52,7 @@ The end result can be seen at [docusaurus-crowdin-example.netlify.app](https://d Initialize a new Docusaurus site: ```bash -npm init docusaurus@latest website classic +npx create-docusaurus@latest website classic ``` Add the site configuration for the French language: diff --git a/website/docs/i18n/i18n-git.md b/website/docs/i18n/i18n-git.md index 5a595909f5..186975a1fc 100644 --- a/website/docs/i18n/i18n-git.md +++ b/website/docs/i18n/i18n-git.md @@ -39,7 +39,7 @@ This is a walk-through of using Git to translate a newly initialized English Doc Initialize a new Docusaurus site: ```bash -npm init docusaurus@latest website classic +npx create-docusaurus@latest website classic ``` Add the site configuration for the French language: diff --git a/website/docs/i18n/i18n-tutorial.md b/website/docs/i18n/i18n-tutorial.md index aae7d05806..675b1fba70 100644 --- a/website/docs/i18n/i18n-tutorial.md +++ b/website/docs/i18n/i18n-tutorial.md @@ -8,7 +8,7 @@ This tutorial will walk you through the basis of the **Docusaurus i18n system**. We will add **French** translations to a **newly initialized English Docusaurus website**. -Initialize a new site with `npm init docusaurus@latest website classic` (like [this one](https://github.com/facebook/docusaurus/tree/main/examples/classic)). +Initialize a new site with `npx create-docusaurus@latest website classic` (like [this one](https://github.com/facebook/docusaurus/tree/main/examples/classic)). ## Configure your site {#configure-your-site} diff --git a/website/docs/installation.md b/website/docs/installation.md index 92e6368bb2..68adc214bd 100644 --- a/website/docs/installation.md +++ b/website/docs/installation.md @@ -23,13 +23,13 @@ Use **[docusaurus.new](https://docusaurus.new)** to test Docusaurus immediately The easiest way to install Docusaurus is to use the command line tool that helps you scaffold a skeleton Docusaurus website. You can run this command anywhere in a new empty repository or within an existing repository, it will create a new directory containing the scaffolded files. ```bash -npm init docusaurus@latest [name] [template] +npx create-docusaurus@latest [name] [template] ``` Example: ```bash -npm init docusaurus@latest website classic +npx create-docusaurus@latest website classic ``` If you do not specify `name` or `template`, it will prompt you for them. We recommend the `classic` template so that you can get started quickly, and it contains features found in Docusaurus 1. The `classic` template contains `@docusaurus/preset-classic` which includes standard documentation, a blog, custom pages, and a CSS framework (with dark mode support). You can get up and running extremely quickly with the classic template and customize things later on when you have gained more familiarity with Docusaurus. @@ -37,19 +37,19 @@ If you do not specify `name` or `template`, it will prompt you for them. We reco **[FB-Only]:** If you are setting up a new Docusaurus website for a Facebook open source project, use the `facebook` template instead, which comes with some useful Facebook-specific defaults: ```bash -npm init docusaurus@latest my-website facebook +npx create-docusaurus@latest my-website facebook ``` If you want to skip installing dependencies, use the `--skip-install` option, like the following: ```bash -npm init docusaurus@latest my-website classic -- --skip-install +npx create-docusaurus@latest my-website classic --skip-install ``` You can also use the template's TypeScript variant by passing the `--typescript` flag. ```bash -npm init docusaurus@latest my-website classic -- --typescript +npx create-docusaurus@latest my-website classic --typescript ``` ## Project structure {#project-structure} diff --git a/website/docs/introduction.md b/website/docs/introduction.md index cf2783fee4..be213020ef 100644 --- a/website/docs/introduction.md +++ b/website/docs/introduction.md @@ -26,7 +26,7 @@ Create a new Docusaurus site and follow the **very short** embedded tutorial. Install [Node.js](https://nodejs.org/en/download/) and create a new Docusaurus site: ```bash -npm init docusaurus@latest my-website classic +npx create-docusaurus@latest my-website classic ``` Start the site: diff --git a/website/docs/typescript-support.md b/website/docs/typescript-support.md index dd235ddd5b..7a8db83a8e 100644 --- a/website/docs/typescript-support.md +++ b/website/docs/typescript-support.md @@ -10,7 +10,7 @@ Docusaurus is written in TypeScript, and provides first-class TypeScript support Docusaurus supports writing and using TypeScript theme components. If the init template provides a Typescript variant, you can directly initialize a site with full TypeScript support by using the `--typescript` flag. ```bash -npm init docusaurus@latest my-website classic -- --typescript +npx create-docusaurus@latest my-website classic --typescript ``` Below are some guides on how to migrate an existing project to TypeScript. diff --git a/website/versioned_docs/version-2.0.0-beta.7/i18n/i18n-crowdin.mdx b/website/versioned_docs/version-2.0.0-beta.7/i18n/i18n-crowdin.mdx index f1ae9a11cd..18499225c8 100644 --- a/website/versioned_docs/version-2.0.0-beta.7/i18n/i18n-crowdin.mdx +++ b/website/versioned_docs/version-2.0.0-beta.7/i18n/i18n-crowdin.mdx @@ -51,7 +51,7 @@ The end result can be seen at [docusaurus-crowdin-example.netlify.app](https://d Initialize a new Docusaurus site: ```bash -npm init docusaurus@latest website classic +npx create-docusaurus@latest website classic ``` Add the site configuration for the French language: diff --git a/website/versioned_docs/version-2.0.0-beta.7/i18n/i18n-git.md b/website/versioned_docs/version-2.0.0-beta.7/i18n/i18n-git.md index 5a595909f5..186975a1fc 100644 --- a/website/versioned_docs/version-2.0.0-beta.7/i18n/i18n-git.md +++ b/website/versioned_docs/version-2.0.0-beta.7/i18n/i18n-git.md @@ -39,7 +39,7 @@ This is a walk-through of using Git to translate a newly initialized English Doc Initialize a new Docusaurus site: ```bash -npm init docusaurus@latest website classic +npx create-docusaurus@latest website classic ``` Add the site configuration for the French language: diff --git a/website/versioned_docs/version-2.0.0-beta.7/i18n/i18n-tutorial.md b/website/versioned_docs/version-2.0.0-beta.7/i18n/i18n-tutorial.md index aae7d05806..675b1fba70 100644 --- a/website/versioned_docs/version-2.0.0-beta.7/i18n/i18n-tutorial.md +++ b/website/versioned_docs/version-2.0.0-beta.7/i18n/i18n-tutorial.md @@ -8,7 +8,7 @@ This tutorial will walk you through the basis of the **Docusaurus i18n system**. We will add **French** translations to a **newly initialized English Docusaurus website**. -Initialize a new site with `npm init docusaurus@latest website classic` (like [this one](https://github.com/facebook/docusaurus/tree/main/examples/classic)). +Initialize a new site with `npx create-docusaurus@latest website classic` (like [this one](https://github.com/facebook/docusaurus/tree/main/examples/classic)). ## Configure your site {#configure-your-site} diff --git a/website/versioned_docs/version-2.0.0-beta.7/installation.md b/website/versioned_docs/version-2.0.0-beta.7/installation.md index b56f467eba..68adc214bd 100644 --- a/website/versioned_docs/version-2.0.0-beta.7/installation.md +++ b/website/versioned_docs/version-2.0.0-beta.7/installation.md @@ -23,13 +23,13 @@ Use **[docusaurus.new](https://docusaurus.new)** to test Docusaurus immediately The easiest way to install Docusaurus is to use the command line tool that helps you scaffold a skeleton Docusaurus website. You can run this command anywhere in a new empty repository or within an existing repository, it will create a new directory containing the scaffolded files. ```bash -npm init docusaurus@latest [name] [template] +npx create-docusaurus@latest [name] [template] ``` Example: ```bash -npm init docusaurus@latest website classic +npx create-docusaurus@latest website classic ``` If you do not specify `name` or `template`, it will prompt you for them. We recommend the `classic` template so that you can get started quickly, and it contains features found in Docusaurus 1. The `classic` template contains `@docusaurus/preset-classic` which includes standard documentation, a blog, custom pages, and a CSS framework (with dark mode support). You can get up and running extremely quickly with the classic template and customize things later on when you have gained more familiarity with Docusaurus. @@ -37,19 +37,19 @@ If you do not specify `name` or `template`, it will prompt you for them. We reco **[FB-Only]:** If you are setting up a new Docusaurus website for a Facebook open source project, use the `facebook` template instead, which comes with some useful Facebook-specific defaults: ```bash -npm init docusaurus@latest my-website facebook +npx create-docusaurus@latest my-website facebook ``` If you want to skip installing dependencies, use the `--skip-install` option, like the following: ```bash -npm init docusaurus@latest my-website classic --skip-install +npx create-docusaurus@latest my-website classic --skip-install ``` You can also use the template's TypeScript variant by passing the `--typescript` flag. ```bash -npm init docusaurus@latest my-website classic --typescript +npx create-docusaurus@latest my-website classic --typescript ``` ## Project structure {#project-structure} diff --git a/website/versioned_docs/version-2.0.0-beta.7/introduction.md b/website/versioned_docs/version-2.0.0-beta.7/introduction.md index cf2783fee4..be213020ef 100644 --- a/website/versioned_docs/version-2.0.0-beta.7/introduction.md +++ b/website/versioned_docs/version-2.0.0-beta.7/introduction.md @@ -26,7 +26,7 @@ Create a new Docusaurus site and follow the **very short** embedded tutorial. Install [Node.js](https://nodejs.org/en/download/) and create a new Docusaurus site: ```bash -npm init docusaurus@latest my-website classic +npx create-docusaurus@latest my-website classic ``` Start the site: diff --git a/website/versioned_docs/version-2.0.0-beta.7/typescript-support.md b/website/versioned_docs/version-2.0.0-beta.7/typescript-support.md index 6dbcdd0bba..7a8db83a8e 100644 --- a/website/versioned_docs/version-2.0.0-beta.7/typescript-support.md +++ b/website/versioned_docs/version-2.0.0-beta.7/typescript-support.md @@ -10,7 +10,7 @@ Docusaurus is written in TypeScript, and provides first-class TypeScript support Docusaurus supports writing and using TypeScript theme components. If the init template provides a Typescript variant, you can directly initialize a site with full TypeScript support by using the `--typescript` flag. ```bash -npm init docusaurus@latest my-website classic --typescript +npx create-docusaurus@latest my-website classic --typescript ``` Below are some guides on how to migrate an existing project to TypeScript. diff --git a/website/versioned_docs/version-2.0.0-beta.8/i18n/i18n-crowdin.mdx b/website/versioned_docs/version-2.0.0-beta.8/i18n/i18n-crowdin.mdx index 953372107d..b6b2fa31a5 100644 --- a/website/versioned_docs/version-2.0.0-beta.8/i18n/i18n-crowdin.mdx +++ b/website/versioned_docs/version-2.0.0-beta.8/i18n/i18n-crowdin.mdx @@ -52,7 +52,7 @@ The end result can be seen at [docusaurus-crowdin-example.netlify.app](https://d Initialize a new Docusaurus site: ```bash -npm init docusaurus@latest website classic +npx create-docusaurus@latest website classic ``` Add the site configuration for the French language: diff --git a/website/versioned_docs/version-2.0.0-beta.8/i18n/i18n-git.md b/website/versioned_docs/version-2.0.0-beta.8/i18n/i18n-git.md index 5a595909f5..186975a1fc 100644 --- a/website/versioned_docs/version-2.0.0-beta.8/i18n/i18n-git.md +++ b/website/versioned_docs/version-2.0.0-beta.8/i18n/i18n-git.md @@ -39,7 +39,7 @@ This is a walk-through of using Git to translate a newly initialized English Doc Initialize a new Docusaurus site: ```bash -npm init docusaurus@latest website classic +npx create-docusaurus@latest website classic ``` Add the site configuration for the French language: diff --git a/website/versioned_docs/version-2.0.0-beta.8/i18n/i18n-tutorial.md b/website/versioned_docs/version-2.0.0-beta.8/i18n/i18n-tutorial.md index aae7d05806..675b1fba70 100644 --- a/website/versioned_docs/version-2.0.0-beta.8/i18n/i18n-tutorial.md +++ b/website/versioned_docs/version-2.0.0-beta.8/i18n/i18n-tutorial.md @@ -8,7 +8,7 @@ This tutorial will walk you through the basis of the **Docusaurus i18n system**. We will add **French** translations to a **newly initialized English Docusaurus website**. -Initialize a new site with `npm init docusaurus@latest website classic` (like [this one](https://github.com/facebook/docusaurus/tree/main/examples/classic)). +Initialize a new site with `npx create-docusaurus@latest website classic` (like [this one](https://github.com/facebook/docusaurus/tree/main/examples/classic)). ## Configure your site {#configure-your-site} diff --git a/website/versioned_docs/version-2.0.0-beta.8/installation.md b/website/versioned_docs/version-2.0.0-beta.8/installation.md index 92e6368bb2..68adc214bd 100644 --- a/website/versioned_docs/version-2.0.0-beta.8/installation.md +++ b/website/versioned_docs/version-2.0.0-beta.8/installation.md @@ -23,13 +23,13 @@ Use **[docusaurus.new](https://docusaurus.new)** to test Docusaurus immediately The easiest way to install Docusaurus is to use the command line tool that helps you scaffold a skeleton Docusaurus website. You can run this command anywhere in a new empty repository or within an existing repository, it will create a new directory containing the scaffolded files. ```bash -npm init docusaurus@latest [name] [template] +npx create-docusaurus@latest [name] [template] ``` Example: ```bash -npm init docusaurus@latest website classic +npx create-docusaurus@latest website classic ``` If you do not specify `name` or `template`, it will prompt you for them. We recommend the `classic` template so that you can get started quickly, and it contains features found in Docusaurus 1. The `classic` template contains `@docusaurus/preset-classic` which includes standard documentation, a blog, custom pages, and a CSS framework (with dark mode support). You can get up and running extremely quickly with the classic template and customize things later on when you have gained more familiarity with Docusaurus. @@ -37,19 +37,19 @@ If you do not specify `name` or `template`, it will prompt you for them. We reco **[FB-Only]:** If you are setting up a new Docusaurus website for a Facebook open source project, use the `facebook` template instead, which comes with some useful Facebook-specific defaults: ```bash -npm init docusaurus@latest my-website facebook +npx create-docusaurus@latest my-website facebook ``` If you want to skip installing dependencies, use the `--skip-install` option, like the following: ```bash -npm init docusaurus@latest my-website classic -- --skip-install +npx create-docusaurus@latest my-website classic --skip-install ``` You can also use the template's TypeScript variant by passing the `--typescript` flag. ```bash -npm init docusaurus@latest my-website classic -- --typescript +npx create-docusaurus@latest my-website classic --typescript ``` ## Project structure {#project-structure} diff --git a/website/versioned_docs/version-2.0.0-beta.8/introduction.md b/website/versioned_docs/version-2.0.0-beta.8/introduction.md index cf2783fee4..be213020ef 100644 --- a/website/versioned_docs/version-2.0.0-beta.8/introduction.md +++ b/website/versioned_docs/version-2.0.0-beta.8/introduction.md @@ -26,7 +26,7 @@ Create a new Docusaurus site and follow the **very short** embedded tutorial. Install [Node.js](https://nodejs.org/en/download/) and create a new Docusaurus site: ```bash -npm init docusaurus@latest my-website classic +npx create-docusaurus@latest my-website classic ``` Start the site: diff --git a/website/versioned_docs/version-2.0.0-beta.8/typescript-support.md b/website/versioned_docs/version-2.0.0-beta.8/typescript-support.md index dd235ddd5b..7a8db83a8e 100644 --- a/website/versioned_docs/version-2.0.0-beta.8/typescript-support.md +++ b/website/versioned_docs/version-2.0.0-beta.8/typescript-support.md @@ -10,7 +10,7 @@ Docusaurus is written in TypeScript, and provides first-class TypeScript support Docusaurus supports writing and using TypeScript theme components. If the init template provides a Typescript variant, you can directly initialize a site with full TypeScript support by using the `--typescript` flag. ```bash -npm init docusaurus@latest my-website classic -- --typescript +npx create-docusaurus@latest my-website classic --typescript ``` Below are some guides on how to migrate an existing project to TypeScript.