fix(v2): codesandbox generated examples should use published init package (#3760)

* Fix codesandbox generated examples to use published init script instead of local one

* Fix codesandbox generated examples to use published init script instead of local one

examples/bootstrap/.gitignore

@@ -1,20 +0,0 @@
-# Dependencies
-/node_modules
-
-# Production
-/build
-
-# Generated files
-.docusaurus
-.cache-loader
-
-# Misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*

examples/bootstrap/docusaurus.config.js

@@ -4,7 +4,6 @@ module.exports = {
   url: 'https://your-docusaurus-test-site.com',
   baseUrl: '/',
   onBrokenLinks: 'throw',
-  onBrokenMarkdownLinks: 'warn',
   favicon: 'img/favicon.ico',
   organizationName: 'facebook', // Usually your GitHub org/user name.
   projectName: 'docusaurus', // Usually your repo name.

examples/classic/docusaurus.config.js

@@ -4,7 +4,6 @@ module.exports = {
   url: 'https://your-docusaurus-test-site.com',
   baseUrl: '/',
   onBrokenLinks: 'throw',
-  onBrokenMarkdownLinks: 'warn',
   favicon: 'img/favicon.ico',
   organizationName: 'facebook', // Usually your GitHub org/user name.
   projectName: 'docusaurus', // Usually your repo name.

examples/classic/package.json

@@ -9,20 +9,19 @@
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
     "serve": "docusaurus serve",
-    "clear": "docusaurus clear",
     "dev": "docusaurus start"
   },
   "dependencies": {
     "@docusaurus/core": "2.0.0-alpha.66",
     "@docusaurus/preset-classic": "2.0.0-alpha.66",
-    "@mdx-js/react": "^1.6.21",
+    "@mdx-js/react": "^1.5.8",
     "clsx": "^1.1.1",
     "react": "^16.8.4",
     "react-dom": "^16.8.4"
   },
   "browserslist": {
     "production": [
-      ">0.5%",
+      ">0.2%",
       "not dead",
       "not op_mini all"
     ],

examples/classic/yarn.lock

@@ -1537,7 +1537,7 @@
     unist-builder "2.0.3"
     unist-util-visit "2.0.3"
 
-"@mdx-js/react@^1.5.8", "@mdx-js/react@^1.6.21":
+"@mdx-js/react@^1.5.8":
   version "1.6.21"
   resolved "https://registry.yarnpkg.com/@mdx-js/react/-/react-1.6.21.tgz#86d962471a5e160c59a6b32054aa55c0c7ca404e"
   integrity sha512-CgSNT9sq2LAlhEbVlPg7DwUQkypz+CWaWGcJbkgmp9WCAy6vW33CQ44UbKPiH3wet9o+UbXeQOqzZd041va83g==

examples/facebook/docusaurus.config.js

@@ -13,7 +13,6 @@ module.exports = {
   url: 'https://your-docusaurus-test-site.com',
   baseUrl: '/',
   onBrokenLinks: 'throw',
-  onBrokenMarkdownLinks: 'warn',
   favicon: 'img/favicon.ico',
   organizationName: 'facebook', // Usually your GitHub org/user name.
   projectName: 'docusaurus', // Usually your repo name.

examples/facebook/package.json

@@ -9,7 +9,6 @@
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
     "serve": "docusaurus serve",
-    "clear": "docusaurus clear",
     "ci": "yarn lint && yarn prettier:diff",
     "lint": "eslint --cache \"**/*.js\" && stylelint \"**/*.css\"",
     "prettier": "prettier --config .prettierrc --write \"**/*.{js,md}\"",
@@ -19,7 +18,7 @@
   "dependencies": {
     "@docusaurus/core": "2.0.0-alpha.66",
     "@docusaurus/preset-classic": "2.0.0-alpha.66",
-    "@mdx-js/react": "^1.6.21",
+    "@mdx-js/react": "^1.5.8",
     "clsx": "^1.1.1",
     "react": "^16.8.4",
     "react-dom": "^16.8.4"
@@ -39,7 +38,7 @@
   },
   "browserslist": {
     "production": [
-      ">0.5%",
+      ">0.2%",
       "not dead",
       "not op_mini all"
     ],

examples/facebook/yarn.lock

@@ -1537,7 +1537,7 @@
     unist-builder "2.0.3"
     unist-util-visit "2.0.3"
 
-"@mdx-js/react@^1.5.8", "@mdx-js/react@^1.6.21":
+"@mdx-js/react@^1.5.8":
   version "1.6.21"
   resolved "https://registry.yarnpkg.com/@mdx-js/react/-/react-1.6.21.tgz#86d962471a5e160c59a6b32054aa55c0c7ca404e"
   integrity sha512-CgSNT9sq2LAlhEbVlPg7DwUQkypz+CWaWGcJbkgmp9WCAy6vW33CQ44UbKPiH3wet9o+UbXeQOqzZd041va83g==

generateExamples.js

@@ -10,6 +10,9 @@ const rimraf = require('rimraf');
 const {readFileSync, writeFileSync, readdir} = require('fs');
 const {execSync} = require('child_process');
 
+// Generate one example per init template
+// We use those generated examples as CodeSandbox projects
+// See https://github.com/facebook/docusaurus/issues/1699
 function generateTemplateExample(template) {
   try {
     console.log(
@@ -18,8 +21,14 @@ function generateTemplateExample(template) {
 
     // run the docusaurus script to bootstrap the template in the examples folder
     execSync(
-      `node ./packages/docusaurus-init/bin/index.js init examples/${template} ${template}`,
+      // /!\ we use the published init script on purpose,
-      {stdio: 'inherit'},
+      // because using the local init script is too early and could generate upcoming/unavailable config options
+      // remember CodeSandbox templates will use the published version, not the repo version
+      `npx @docusaurus/init@next init examples/${template} ${template}`,
+      // `node ./packages/docusaurus-init/bin/index.js init examples/${template} ${template}`,
+      {
+        stdio: 'inherit',
+      },
     );
 
     // read the content of the package.json

package.json

@@ -15,7 +15,7 @@
     "start:v2:baseUrl": "yarn workspace docusaurus-2-website start:baseUrl",
     "start:v2:bootstrap": "yarn workspace docusaurus-2-website start:bootstrap",
     "start:v2:blogOnly": "yarn workspace docusaurus-2-website start:blogOnly",
-    "examples:generate": "node codesandboxscript",
+    "examples:generate": "node generateExamples",
     "build": "yarn build:packages && yarn build:v2",
     "build:packages": "lerna run build --no-private",
     "build:v1": "yarn workspace docusaurus-1-website build",