3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-29 22:47:52 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: Link initialization docs together (#10740)

Browse source
This commit is contained in:
Waldir Pimenta 2024-12-05 12:55:59 +00:00 • committed by GitHub
parent a995865314
commit 01cad20b5a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
website/docs/installation.mdx
View file

@ -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

2
website/docs/typescript-support.mdx
View file

@ -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

4
website/docusaurus.config.ts
View file

@ -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,