Skip to content

Commit

Permalink
docs: Link initialization docs together (#10740)
Browse files Browse the repository at this point in the history
  • Loading branch information
waldyrious authored Dec 5, 2024
1 parent a995865 commit 01cad20
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion website/docs/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.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
Expand Down
2 changes: 1 addition & 1 deletion website/docs/typescript-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.mdx#scaffold-project-website) with full TypeScript support by using the `--typescript` flag.

```bash
npx create-docusaurus@latest my-website classic --typescript
Expand Down
4 changes: 4 additions & 0 deletions website/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 01cad20

Please sign in to comment.