3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-29 10:17:55 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: add note regarding ts extension for config file. (#10082)

Browse source
This commit is contained in:
Mikey O'Toole 2024-04-28 17:39:23 +01:00 • committed by GitHub
parent da2c0b4eae
commit e20b3294df
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
website/docs/api/docusaurus.config.js.mdx
View file

@ -18,6 +18,12 @@ Refer to the Getting Started [**Configuration**](../configuration.mdx) for examp
`docusaurus.config.js` contains configurations for your site and is placed in the root directory of your site.
:::note
With a [TypeScript](../typescript-support.mdx) Docusaurus codebase your config file may be called `docusaurus.config.ts`. The syntax is broadly identical to the `js` config file with the addition of types. You can see an example on the [Docusaurus Website](https://github.com/facebook/docusaurus/blob/main/website/docusaurus.config.ts) itself.
:::
This file is run in Node.js and should export a site configuration object, or a function that creates it.
The `docusaurus.config.js` file supports: