Skip to content

Commit

Permalink
docs: add note regarding ts extension for config file. (#10082)
Browse files Browse the repository at this point in the history
  • Loading branch information
homotechsual committed Apr 28, 2024
1 parent da2c0b4 commit e20b329
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions website/docs/api/docusaurus.config.js.mdx
Expand Up @@ -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:
Expand Down

0 comments on commit e20b329

Please sign in to comment.