From c00915eb8550f57fa96456bca94dc1dbe5c6d055 Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Wed, 4 Dec 2024 16:43:08 +0000 Subject: [PATCH 1/2] docs: Link initialization docs together --- website/docs/installation.mdx | 2 +- website/docs/typescript-support.mdx | 2 +- website/docusaurus.config.ts | 4 ++++ 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/website/docs/installation.mdx b/website/docs/installation.mdx index 1da802db425d..8dc3ed3ad6f4 100644 --- a/website/docs/installation.mdx +++ b/website/docs/installation.mdx @@ -26,7 +26,7 @@ Use **[docusaurus.new](https://docusaurus.new)** to test Docusaurus immediately ## Scaffold project website {#scaffold-project-website} -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. +The easiest way to install Docusaurus is to use the [`create-docusaurus`](./api/misc/create-docusaurus) 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 npx create-docusaurus@latest my-website classic diff --git a/website/docs/typescript-support.mdx b/website/docs/typescript-support.mdx index 1493cbe123c7..1f18106c25df 100644 --- a/website/docs/typescript-support.mdx +++ b/website/docs/typescript-support.mdx @@ -10,7 +10,7 @@ The minimum required version is **TypeScript 5.1**. ## Initialization {#initialization} -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. +Docusaurus supports writing and using TypeScript theme components. If the init template provides a TypeScript variant, you can directly [initialize a site](./installation#scaffold-project-website) with full TypeScript support by using the `--typescript` flag. ```bash npx create-docusaurus@latest my-website classic --typescript diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 852a0b4e3c83..fabe2ce34553 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -347,6 +347,10 @@ export default async function createConfigAsync() { from: ['/docs/resources', '/docs/next/resources'], to: '/community/resources', }, + { + from: '/docs/api/misc/docusaurus-init', + to: '/docs/api/misc/create-docusaurus', + }, ...dogfoodingRedirects, ], } satisfies ClientRedirectsOptions, From 900eea7b147b7634a382a15c44d38bbb1f193a0d Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Wed, 4 Dec 2024 17:06:37 +0000 Subject: [PATCH 2/2] fix links --- website/docs/installation.mdx | 2 +- website/docs/typescript-support.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/installation.mdx b/website/docs/installation.mdx index 8dc3ed3ad6f4..1d4ca017b983 100644 --- a/website/docs/installation.mdx +++ b/website/docs/installation.mdx @@ -26,7 +26,7 @@ Use **[docusaurus.new](https://docusaurus.new)** to test Docusaurus immediately ## Scaffold project website {#scaffold-project-website} -The easiest way to install Docusaurus is to use the [`create-docusaurus`](./api/misc/create-docusaurus) 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. +The easiest way to install Docusaurus is to use the [`create-docusaurus`](./api/misc/create-docusaurus.mdx) 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 npx create-docusaurus@latest my-website classic diff --git a/website/docs/typescript-support.mdx b/website/docs/typescript-support.mdx index 1f18106c25df..6da089e2a7d0 100644 --- a/website/docs/typescript-support.mdx +++ b/website/docs/typescript-support.mdx @@ -10,7 +10,7 @@ The minimum required version is **TypeScript 5.1**. ## Initialization {#initialization} -Docusaurus supports writing and using TypeScript theme components. If the init template provides a TypeScript variant, you can directly [initialize a site](./installation#scaffold-project-website) with full TypeScript support by using the `--typescript` flag. +Docusaurus supports writing and using TypeScript theme components. If the init template provides a TypeScript variant, you can directly [initialize a site](./installation.mdx#scaffold-project-website) with full TypeScript support by using the `--typescript` flag. ```bash npx create-docusaurus@latest my-website classic --typescript