create-docusaurus 2.0.0-beta.17 → 2.0.0-beta.20

package/bin/index.js

@@ -13,7 +13,6 @@ import semver from 'semver';
 import path from 'path';
 import {program} from 'commander';
 import {createRequire} from 'module';
-import init from '../lib/index.js';
 
 const packageJson = createRequire(import.meta.url)('../package.json');
 const requiredVersion = packageJson.engines.node;
@@ -24,14 +23,6 @@ if (!semver.satisfies(process.version, requiredVersion)) {
   process.exit(1);
 }
 
-function wrapCommand(fn) {
-  return (...args) =>
-    fn(...args).catch((err) => {
-      logger.error(err.stack);
-      process.exitCode = 1;
-    });
-}
-
 program.version(packageJson.version);
 
 program
@@ -61,11 +52,14 @@ program
       rootDir = '.',
       {packageManager, skipInstall, typescript, gitStrategy} = {},
     ) => {
-      wrapCommand(init)(path.resolve(rootDir), siteName, template, {
-        packageManager,
-        skipInstall,
-        typescript,
-        gitStrategy,
+      // See https://github.com/facebook/docusaurus/pull/6860
+      import('../lib/index.js').then(({default: init}) => {
+        init(path.resolve(rootDir), siteName, template, {
+          packageManager,
+          skipInstall,
+          typescript,
+          gitStrategy,
+        });
       });
     },
   );
@@ -75,3 +69,8 @@ program.parse(process.argv);
 if (!process.argv.slice(1).length) {
   program.outputHelp();
 }
+
+process.on('unhandledRejection', (err) => {
+  logger.error(err);
+  process.exit(1);
+});

package/lib/index.js

@@ -25,7 +25,7 @@ const SupportedPackageManagers = {
 const PackageManagersList = Object.keys(SupportedPackageManagers);
 async function findPackageManagerFromLockFile() {
     for (const packageManager of PackageManagersList) {
-        const lockFilePath = path.resolve(process.cwd(), SupportedPackageManagers[packageManager]);
+        const lockFilePath = path.resolve(SupportedPackageManagers[packageManager]);
         if (await fs.pathExists(lockFilePath)) {
             return packageManager;
         }
@@ -37,11 +37,11 @@ function findPackageManagerFromUserAgent() {
 }
 async function askForPackageManagerChoice() {
     const hasYarn = shell.exec('yarn --version', { silent: true }).code === 0;
-    const hasPNPM = shell.exec('pnpm --version', { silent: true }).code === 0;
-    if (!hasYarn && !hasPNPM) {
+    const hasPnpm = shell.exec('pnpm --version', { silent: true }).code === 0;
+    if (!hasYarn && !hasPnpm) {
         return 'npm';
     }
-    const choices = ['npm', hasYarn && 'yarn', hasPNPM && 'pnpm']
+    const choices = ['npm', hasYarn && 'yarn', hasPnpm && 'pnpm']
         .filter((p) => Boolean(p))
         .map((p) => ({ title: p, value: p }));
     return (await prompts({
@@ -66,8 +66,7 @@ function isValidGitRepoUrl(gitRepoUrl) {
     return ['https://', 'git@'].some((item) => gitRepoUrl.startsWith(item));
 }
 async function updatePkg(pkgPath, obj) {
-    const content = await fs.readFile(pkgPath, 'utf-8');
-    const pkg = JSON.parse(content);
+    const pkg = await fs.readJSON(pkgPath);
     const newPkg = Object.assign(pkg, obj);
     await fs.outputFile(pkgPath, `${JSON.stringify(newPkg, null, 2)}\n`);
 }
@@ -97,7 +96,7 @@ function getTypeScriptBaseTemplate(template) {
     return undefined;
 }
 async function copyTemplate(templatesDir, template, dest) {
-    await fs.copy(path.resolve(templatesDir, 'shared'), dest);
+    await fs.copy(path.join(templatesDir, 'shared'), dest);
     // TypeScript variants will copy duplicate resources like CSS & config from
     // base template
     const tsBaseTemplate = getTypeScriptBaseTemplate(template);
@@ -110,7 +109,7 @@ async function copyTemplate(templatesDir, template, dest) {
         });
     }
     await fs.copy(path.resolve(templatesDir, template), dest, {
-        // Symlinks don't exist in published NPM packages anymore, so this is only
+        // Symlinks don't exist in published npm packages anymore, so this is only
         // to prevent errors during local testing
         filter: async (filePath) => !(await fs.lstat(filePath)).isSymbolicLink(),
     });
@@ -137,7 +136,7 @@ async function getGitCommand(gitStrategy) {
 export default async function init(rootDir, siteName, reqTemplate, cliOptions = {}) {
     const templatesDir = fileURLToPath(new URL('../templates', import.meta.url));
     const templates = await readTemplates(templatesDir);
-    const hasTS = (templateName) => fs.pathExists(path.resolve(templatesDir, `${templateName}${TypeScriptTemplateSuffix}`));
+    const hasTS = (templateName) => fs.pathExists(path.join(templatesDir, `${templateName}${TypeScriptTemplateSuffix}`));
     let name = siteName;
     // Prompt if siteName is not passed from CLI.
     if (!name) {
@@ -192,7 +191,7 @@ export default async function init(rootDir, siteName, reqTemplate, cliOptions =
                 return logger.red('Invalid repository URL');
             },
             message: logger.interpolate `Enter a repository URL from GitHub, Bitbucket, GitLab, or any other public repo.
-(e.g: path=${'https://github.com/ownerName/repoName.git'})`,
+(e.g: url=${'https://github.com/ownerName/repoName.git'})`,
         });
         ({ gitStrategy } = await prompts({
             type: 'select',
@@ -216,7 +215,7 @@ export default async function init(rootDir, siteName, reqTemplate, cliOptions =
             name: 'templateDir',
             validate: async (dir) => {
                 if (dir) {
-                    const fullDir = path.resolve(process.cwd(), dir);
+                    const fullDir = path.resolve(dir);
                     if (await fs.pathExists(fullDir)) {
                         return true;
                     }
@@ -234,7 +233,7 @@ export default async function init(rootDir, siteName, reqTemplate, cliOptions =
     }
     logger.info('Creating new Docusaurus project...');
     if (isValidGitRepoUrl(template)) {
-        logger.info `Cloning Git template path=${template}...`;
+        logger.info `Cloning Git template url=${template}...`;
         if (!gitStrategies.includes(gitStrategy)) {
             logger.error `Invalid git strategy: name=${gitStrategy}. Value must be one of ${gitStrategies.join(', ')}.`;
             process.exit(1);
@@ -252,7 +251,7 @@ export default async function init(rootDir, siteName, reqTemplate, cliOptions =
         // Docusaurus templates.
         if (useTS) {
             if (!(await hasTS(template))) {
-                logger.error `Template name=${template} doesn't provide the Typescript variant.`;
+                logger.error `Template name=${template} doesn't provide the TypeScript variant.`;
                 process.exit(1);
             }
             template = `${template}${TypeScriptTemplateSuffix}`;
@@ -265,8 +264,8 @@ export default async function init(rootDir, siteName, reqTemplate, cliOptions =
             throw err;
         }
     }
-    else if (await fs.pathExists(path.resolve(process.cwd(), template))) {
-        const templateDir = path.resolve(process.cwd(), template);
+    else if (await fs.pathExists(path.resolve(template))) {
+        const templateDir = path.resolve(template);
         try {
             await fs.copy(templateDir, dest);
         }
@@ -322,7 +321,7 @@ export default async function init(rootDir, siteName, reqTemplate, cliOptions =
         }
     }
     const useNpm = pkgManager === 'npm';
-    logger.success `Created path=${cdpath}.`;
+    logger.success `Created name=${cdpath}.`;
     logger.info `Inside that directory, you can run several commands:
 
   code=${`${pkgManager} start`}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-docusaurus",
-  "version": "2.0.0-beta.17",
+  "version": "2.0.0-beta.20",
   "description": "Create Docusaurus apps easily.",
   "type": "module",
   "repository": {
@@ -13,8 +13,8 @@
   },
   "scripts": {
     "create-docusaurus": "create-docusaurus",
-    "build": "tsc",
-    "watch": "tsc --watch"
+    "build": "tsc -p tsconfig.build.json",
+    "watch": "tsc -p tsconfig.build.json --watch"
   },
   "bin": "bin/index.js",
   "publishConfig": {
@@ -22,15 +22,15 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/logger": "2.0.0-beta.17",
+    "@docusaurus/logger": "2.0.0-beta.20",
     "commander": "^5.1.0",
-    "fs-extra": "^10.0.1",
+    "fs-extra": "^10.1.0",
     "lodash": "^4.17.21",
     "prompts": "^2.4.2",
-    "semver": "^7.3.5",
+    "semver": "^7.3.7",
     "shelljs": "^0.8.5",
-    "supports-color": "^9.2.1",
-    "tslib": "^2.3.1"
+    "supports-color": "^9.2.2",
+    "tslib": "^2.4.0"
   },
   "devDependencies": {
     "@types/supports-color": "^8.1.1"
@@ -38,5 +38,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "0032c0b0480083227af2e1b4da2d3ee6ce992403"
+  "gitHead": "ed5cdba401a5948e187e927039b142a0decc702d"
 }

package/templates/classic/docusaurus.config.js

@@ -13,9 +13,20 @@ const config = {
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
   favicon: 'img/favicon.ico',
+
+  // GitHub pages deployment config.
+  // If you aren't using GitHub pages, you don't need these.
   organizationName: 'facebook', // Usually your GitHub org/user name.
   projectName: 'docusaurus', // Usually your repo name.
 
+  // Even if you don't use internalization, you can use this field to set useful
+  // metadata like html lang. For example, if your site is Chinese, you may want
+  // to replace "en" with "zh-Hans".
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
   presets: [
     [
       'classic',
@@ -24,11 +35,14 @@ const config = {
         docs: {
           sidebarPath: require.resolve('./sidebars.js'),
           // Please change this to your repo.
-          editUrl: 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
+          // Remove this to remove the "edit this page" links.
+          editUrl:
+            'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
         },
         blog: {
           showReadingTime: true,
           // Please change this to your repo.
+          // Remove this to remove the "edit this page" links.
           editUrl:
             'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
         },

package/templates/classic/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-2-classic-template",
-  "version": "2.0.0-beta.17",
+  "version": "2.0.0-beta.20",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -14,13 +14,16 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.17",
-    "@docusaurus/preset-classic": "2.0.0-beta.17",
+    "@docusaurus/core": "2.0.0-beta.20",
+    "@docusaurus/preset-classic": "2.0.0-beta.20",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
-    "prism-react-renderer": "^1.2.1",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1"
+    "prism-react-renderer": "^1.3.1",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
+  },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "2.0.0-beta.20"
   },
   "browserslist": {
     "production": [

package/templates/classic/src/css/custom.css

@@ -14,6 +14,7 @@
   --ifm-color-primary-lighter: #359962;
   --ifm-color-primary-lightest: #3cad6e;
   --ifm-code-font-size: 95%;
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
 }
 
 /* For readability concerns, you should choose a lighter palette in dark mode. */
@@ -25,15 +26,5 @@
   --ifm-color-primary-light: #29d5b0;
   --ifm-color-primary-lighter: #32d8b4;
   --ifm-color-primary-lightest: #4fddbf;
-}
-
-.docusaurus-highlight-code-line {
-  background-color: rgba(0, 0, 0, 0.1);
-  display: block;
-  margin: 0 calc(-1 * var(--ifm-pre-padding));
-  padding: 0 var(--ifm-pre-padding);
-}
-
-[data-theme='dark'] .docusaurus-highlight-code-line {
-  background-color: rgba(0, 0, 0, 0.3);
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
 }

package/templates/classic-typescript/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-2-classic-typescript-template",
-  "version": "2.0.0-beta.17",
+  "version": "2.0.0-beta.20",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -15,18 +15,18 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.17",
-    "@docusaurus/preset-classic": "2.0.0-beta.17",
+    "@docusaurus/core": "2.0.0-beta.20",
+    "@docusaurus/preset-classic": "2.0.0-beta.20",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
-    "prism-react-renderer": "^1.2.1",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1"
+    "prism-react-renderer": "^1.3.1",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.17",
-    "@tsconfig/docusaurus": "^1.0.4",
-    "typescript": "^4.6.2"
+    "@docusaurus/module-type-aliases": "2.0.0-beta.20",
+    "@tsconfig/docusaurus": "^1.0.5",
+    "typescript": "^4.6.4"
   },
   "browserslist": {
     "production": [

package/templates/facebook/docusaurus.config.js

@@ -18,6 +18,9 @@ const config = {
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
   favicon: 'img/favicon.ico',
+
+  // GitHub pages deployment config.
+  // If you aren't using GitHub pages, you don't need these.
   organizationName: 'facebook', // Usually your GitHub org/user name.
   projectName: 'docusaurus', // Usually your repo name.
 
@@ -29,12 +32,14 @@ const config = {
         docs: {
           sidebarPath: require.resolve('./sidebars.js'),
           // Please change this to your repo.
+          // Remove this to remove the "edit this page" links.
           editUrl:
             'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
         },
         blog: {
           showReadingTime: true,
           // Please change this to your repo.
+          // Remove this to remove the "edit this page" links.
           editUrl:
             'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
         },

package/templates/facebook/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-2-facebook-template",
-  "version": "2.0.0-beta.17",
+  "version": "2.0.0-beta.20",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -18,25 +18,25 @@
     "format:diff": "prettier --config .prettierrc --list-different \"**/*.{js,jsx,ts,tsx,md,mdx}\""
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.17",
-    "@docusaurus/preset-classic": "2.0.0-beta.17",
+    "@docusaurus/core": "2.0.0-beta.20",
+    "@docusaurus/preset-classic": "2.0.0-beta.20",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1"
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "^7.16.3",
-    "eslint": "^8.8.0",
-    "eslint-config-airbnb": "^19.0.0",
-    "eslint-config-prettier": "^8.4.0",
+    "@babel/eslint-parser": "^7.17.0",
+    "eslint": "^8.14.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-header": "^3.1.1",
-    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jsx-a11y": "^6.5.1",
-    "eslint-plugin-react": "^7.29.2",
-    "eslint-plugin-react-hooks": "^4.3.0",
-    "prettier": "^2.5.1",
-    "stylelint": "^14.5.3"
+    "eslint-plugin-react": "^7.29.4",
+    "eslint-plugin-react-hooks": "^4.5.0",
+    "prettier": "^2.6.2",
+    "stylelint": "^14.8.1"
   },
   "browserslist": {
     "production": [

package/templates/facebook/src/css/custom.css

@@ -35,10 +35,3 @@
   --ifm-color-primary-lighter: #32d8b4;
   --ifm-color-primary-lightest: #4fddbf;
 }
-
-.docusaurus-highlight-code-line {
-  background-color: rgb(72, 77, 91);
-  display: block;
-  margin: 0 calc(-1 * var(--ifm-pre-padding));
-  padding: 0 var(--ifm-pre-padding);
-}

package/templates/shared/docs/tutorial-basics/_category_.json

@@ -1,4 +1,8 @@
 {
   "label": "Tutorial - Basics",
-  "position": 2
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "5 minutes to learn the most important Docusaurus concepts."
+  }
 }

package/templates/shared/docs/tutorial-basics/create-a-document.md

@@ -41,14 +41,14 @@ This is my **first Docusaurus document**!
 
 It is also possible to create your sidebar explicitly in `sidebars.js`:
 
-```diff title="sidebars.js"
+```js title="sidebars.js"
 module.exports = {
   tutorialSidebar: [
     {
       type: 'category',
       label: 'Tutorial',
--     items: [...],
-+     items: ['hello'],
+      // highlight-next-line
+      items: ['hello'],
     },
   ],
 };

package/templates/shared/docs/tutorial-basics/markdown-features.mdx

@@ -43,7 +43,7 @@ Let's see how to [Create a page](./create-a-page.md).
 
 Regular Markdown images are supported.
 
-Add an image at `static/img/docusaurus.png` and display it in Markdown:
+You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`):
 
 ```md
 ![Docusaurus logo](/img/docusaurus.png)
@@ -51,6 +51,8 @@ Add an image at `static/img/docusaurus.png` and display it in Markdown:
 
 ![Docusaurus logo](/img/docusaurus.png)
 
+You can reference images relative to the current file as well, as shown in [the extra guides](../tutorial-extras/manage-docs-versions.md).
+
 ## Code Blocks
 
 Markdown code blocks are supported with Syntax highlighting.

package/templates/shared/docs/tutorial-extras/_category_.json

@@ -1,4 +1,7 @@
 {
   "label": "Tutorial - Extras",
-  "position": 3
+  "position": 3,
+  "link": {
+    "type": "generated-index"
+  }
 }

package/templates/shared/docs/tutorial-extras/manage-docs-versions.md

@@ -45,7 +45,7 @@ module.exports = {
 
 The docs version dropdown appears in your navbar:
 
-![Docs Version Dropdown](/img/tutorial/docsVersionDropdown.png)
+![Docs Version Dropdown](./img/docsVersionDropdown.png)
 
 ## Update an existing version
 

package/templates/shared/docs/tutorial-extras/translate-your-site.md

@@ -71,7 +71,7 @@ module.exports = {
 
 The locale dropdown now appears in your navbar:
 
-![Locale Dropdown](/img/tutorial/localeDropdown.png)
+![Locale Dropdown](./img/localeDropdown.png)
 
 ## Build your localized site