From 2a96ec01de9345feb6dedddfe9f71e6ffc5fb2de Mon Sep 17 00:00:00 2001 From: Thad Guidry Date: Thu, 4 May 2023 00:36:29 +0800 Subject: [PATCH] polish(create-docusaurus): add comment in config to mention different ways to declare config + doc link (#8944) Co-authored-by: Joshua Chen --- .../create-docusaurus/templates/classic/docusaurus.config.js | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/packages/create-docusaurus/templates/classic/docusaurus.config.js b/packages/create-docusaurus/templates/classic/docusaurus.config.js index d67f3df377..d8e50d95a0 100644 --- a/packages/create-docusaurus/templates/classic/docusaurus.config.js +++ b/packages/create-docusaurus/templates/classic/docusaurus.config.js @@ -1,5 +1,8 @@ // @ts-check -// Note: type annotations allow type checking and IDEs autocompletion +// `@type` JSDoc annotations allow editor autocompletion and type checking +// (when paired with `@ts-check`). +// There are various equivalent ways to declare your Docusaurus config. +// See: https://docusaurus.io/docs/api/docusaurus-config const lightCodeTheme = require('prism-react-renderer/themes/github'); const darkCodeTheme = require('prism-react-renderer/themes/dracula');