downmerge from parent

.eslintignore

@@ -22,6 +22,7 @@ packages/docusaurus-plugin-debug/lib/
 packages/docusaurus-plugin-sitemap/lib/
 packages/docusaurus-plugin-ideal-image/lib/
 packages/docusaurus-plugin-ideal-image/copyUntypedFiles.js
+packages/docusaurus-theme-classic/lib/
 
 packages/docusaurus-1.x/.eslintrc.js
 packages/docusaurus-init/templates/facebook/.eslintrc.js

.eslintrc.js

@@ -85,27 +85,23 @@ module.exports = {
     ],
     'no-unused-vars': OFF,
     '@typescript-eslint/no-unused-vars': [ERROR, {argsIgnorePattern: '^_'}],
+    '@typescript-eslint/ban-ts-comment': [
+      ERROR,
+      {'ts-expect-error': 'allow-with-description'},
+    ],
 
     // TODO re-enable some these as errors
     // context: https://github.com/facebook/docusaurus/pull/2949
-    '@typescript-eslint/ban-ts-comment': WARNING,
     '@typescript-eslint/ban-types': WARNING,
-    'import/prefer-default-export': WARNING,
     'import/no-extraneous-dependencies': WARNING,
     'no-useless-escape': WARNING,
     'prefer-template': WARNING,
-    'no-shadow': WARNING,
     'no-param-reassign': WARNING,
-    'no-else-return': WARNING,
     'no-template-curly-in-string': WARNING,
     'array-callback-return': WARNING,
     camelcase: WARNING,
-    'no-nested-ternary': WARNING,
-    'object-shorthand': WARNING,
     'no-restricted-syntax': WARNING,
     'no-unused-expressions': WARNING,
-    'consistent-return': WARNING,
-    'no-useless-return': WARNING,
     '@typescript-eslint/no-empty-function': WARNING,
     'global-require': WARNING,
     'prefer-destructuring': WARNING,
@@ -114,8 +110,6 @@ module.exports = {
     'no-empty': WARNING,
     'no-prototype-builtins': WARNING,
     'no-case-declarations': WARNING,
-    'default-case': WARNING,
-    'dot-notation': WARNING,
   },
   overrides: [
     {

.github/workflows/e2e-test.yml

@@ -11,7 +11,7 @@ on:
       - master
 
 jobs:
-  build:
+  yarn-v1:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -25,7 +25,46 @@ jobs:
       - name: Installation
         run: yarn
       - name: Setup test-website project against master release
-        run: yarn test:build:v2
+        run: |
+          yarn test:build:v2
+          rm -rf node_modules
+      - name: Start test-website project
+        run: cd test-website && yarn start --no-open
+        env:
+          E2E_TEST: true
+      - name: Build test-website project
+        run: cd test-website && yarn build
+        env:
+          CI: true
+  yarn-v2:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [10.x]
+    steps:
+      - uses: actions/checkout@v1
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Installation
+        run: yarn
+      - name: Setup test-website project against master release
+        run: |
+          KEEP_CONTAINER=true yarn test:build:v2
+          rm -rf node_modules
+      - name: Setup test-website project for Yarn v2
+        run: |
+          cd test-website
+          yarn set version berry
+          yarn config set pnpMode loose
+          yarn config set npmRegistryServer http://localhost:4873
+          yarn config set unsafeHttpWhitelist --json '["localhost"]'
+          yarn install
+      - name: Start test-website project
+        run: cd test-website && yarn start --no-open
+        env:
+          E2E_TEST: true
       - name: Build test-website project
         run: cd test-website && yarn build
         env:

.gitignore

@@ -26,3 +26,4 @@ packages/docusaurus-plugin-content-pages/lib/
 packages/docusaurus-plugin-debug/lib/
 packages/docusaurus-plugin-sitemap/lib/
 packages/docusaurus-plugin-ideal-image/lib/
+packages/docusaurus-theme-classic/lib/

.prettierignore

@@ -14,4 +14,5 @@ packages/docusaurus-plugin-content-pages/lib/
 packages/docusaurus-plugin-debug/lib/
 packages/docusaurus-plugin-sitemap/lib/
 packages/docusaurus-plugin-ideal-image/lib/
+packages/docusaurus-theme-classic/lib/
 __fixtures__

admin/scripts/test-release.sh

@@ -27,7 +27,7 @@ git diff --name-only -- '*.json' | sed 's, ,\\&,g' | xargs git checkout --
 npm_config_registry="$CUSTOM_REGISTRY_URL" npx @docusaurus/init@"$NEW_VERSION" init test-website classic
 
 # Stop Docker container
-if ( $(docker container inspect "$CONTAINER_NAME" > /dev/null 2>&1) ); then
+if (! $KEEP_CONTAINER) && ( $(docker container inspect "$CONTAINER_NAME" > /dev/null 2>&1) ); then
   # Remove Docker container
   docker container stop $CONTAINER_NAME > /dev/null
 fi

docs/api-site-config.md

@@ -53,8 +53,8 @@ headerLinks: [
   { doc: "doc1", label: "Getting Started" },
   // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
   { page: "help", label: "Help" },
-  // Links to href destination
-  { href: "https://github.com/", label: "GitHub" },
+  // Links to href destination, using target=_blank (external)
+  { href: "https://github.com/", label: "GitHub", external: true },
   // Links to blog generated by Docusaurus (${baseUrl}blog)
   { blog: true, label: "Blog" },
   // Determines search bar position among links
@@ -128,6 +128,26 @@ customDocsPath: 'website-docs';
 
 The default version for the site to be shown. If this is not set, the latest version will be shown.
 
+#### `deletedDocs` [object]
+
+Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to [fallback functionality](versioning#fallback-functionality). This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.
+
+To force removal of content beginning with a certain version (including for current/next), add a `deletedDocs` object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.
+
+Example:
+
+```js
+{
+  deletedDocs: {
+    "2.0.0": [
+      "tagging"
+    ]
+  }
+}
+```
+
+The version keys must match those in `versions.json`. Assuming the versions list in `versions.json` is `["3.0.0", "2.0.0", "1.1.0", "1.0.0"]`, the `docs/1.0.0/tagging` and `docs/1.1.0/tagging` URLs will work but `docs/2.0.0/tagging`, `docs/3.0.0/tagging`, and `docs/tagging` will not. The files and folders for those versions will not be generated during the build.
+
 #### `docsUrl` [string]
 
 The base URL for all docs file. Set this field to `''` to remove the `docs` prefix of the documentation URL. If unset, it is defaulted to `docs`.

docs/guides-versioning.md

@@ -72,6 +72,8 @@ Only files in the `docs` directory and sidebar files that differ from those of t
 
 For example, a document with the original id `doc1` exists for the latest version, `1.0.0`, and has the same content as the document with the id `doc1` in the `docs` directory. When a new version `2.0.0` is created, the file for `doc1` will not be copied into `versioned_docs/version-2.0.0/`. There will still be a page for `docs/2.0.0/doc1.html`, but it will use the file from version `1.0.0`.
 
+Because of the way this fallback works, pages that you delete are not really deleted from the website unless you tell Docusaurus to skip fallback after a certain version. To do this, use the [`deletedDocs`](api-site-config.md#deleteddocs-object) option in `siteConfig.js`.
+
 ## Renaming Existing Versions
 
 To rename an existing version number to something else, first make sure the following script is in your `package.json` file:

package.json

@@ -7,18 +7,22 @@
     "packages/docusaurus-init/templates/*"
   ],
   "scripts": {
-    "start": "yarn tsc && yarn start:v2",
+    "start": "yarn build:packages && yarn start:v2",
     "start:v1": "yarn workspace docusaurus-1-website start",
     "start:v2": "yarn workspace docusaurus-2-website start",
     "start:v2:watch": "nodemon --watch \"./packages/*/lib/**/*.*\" --exec \"yarn start:v2\"",
-    "build": "yarn tsc && yarn build:v2",
+    "build": "yarn build:packages && yarn build:v2",
+    "build:packages": "lerna run build --no-private",
     "build:v1": "yarn workspace docusaurus-1-website build",
     "build:v2": "yarn workspace docusaurus-2-website build",
-    "serve": "yarn serve:v2",
     "serve:v1": "serve website-1.x/build/docusaurus",
     "serve:v2": "serve website/build",
+    "serve:v2:ssl": "yarn serve:v2:ssl:gencert && yarn serve:v2:ssl:message && yarn serve:v2:ssl:serve",
+    "serve:v2:ssl:gencert": "openssl req -x509 -nodes -days 365 -newkey rsa:4096 -subj \"/C=US/ST=Docusaurus/L=Anywhere/O=Dis/CN=localhost\" -keyout ./website/.docusaurus/selfsigned.key -out ./website/.docusaurus/selfsigned.crt",
+    "serve:v2:ssl:message": "echo '\n\n\nServing Docusaurus with HTTPS on localhost requires to disable the Chrome security: chrome://flags/#allow-insecure-localhost\n\n\n'",
+    "serve:v2:ssl:serve": "serve website/build --ssl-cert ./website/.docusaurus/selfsigned.crt --ssl-key ./website/.docusaurus/selfsigned.key",
     "changelog": "lerna-changelog",
-    "postinstall": "yarn tsc",
+    "postinstall": "yarn build:packages",
     "prettier": "prettier --config .prettierrc --write \"**/*.{js,ts}\"",
     "prettier:diff": "prettier --config .prettierrc --list-different \"**/*.{js,ts}\"",
     "prettier-docs": "prettier --config .prettierrc --write \"**/*.md\"",
@@ -28,17 +32,16 @@
     "lerna": "lerna",
     "test": "jest",
     "test:build:v2": "./admin/scripts/test-release.sh",
-    "tsc": "lerna run tsc --no-private",
+    "tsc": "yarn build:packages && echo '\n\nDOCUSAURUS: yarn tsc is deprecated and will be removed, use yarn build:packages instead\n\n'",
     "watch": "yarn lerna run --parallel --no-private watch",
     "clear": "yarn rimraf website/.docusaurus && rimraf -rf website/node_modules/.cache && yarn lerna exec 'yarn rimraf lib' --ignore docusaurus"
   },
   "devDependencies": {
     "@babel/core": "^7.9.0",
+    "@babel/cli": "^7.9.0",
     "@babel/plugin-proposal-nullish-coalescing-operator": "^7.8.3",
     "@babel/plugin-proposal-optional-chaining": "^7.9.0",
     "@babel/preset-typescript": "^7.9.0",
-    "@typescript-eslint/eslint-plugin": "^3.3.0",
-    "@typescript-eslint/parser": "^3.3.0",
     "@types/express": "^4.17.2",
     "@types/fs-extra": "^8.0.1",
     "@types/inquirer": "^6.5.0",
@@ -54,13 +57,19 @@
     "@types/lodash.pick": "^4.4.6",
     "@types/lodash.pickby": "^4.6.6",
     "@types/node": "^13.11.0",
-    "@types/react": "^16.9.13",
+    "@types/prismjs": "^1.16.1",
+    "@types/react": "^16.9.38",
     "@types/react-dev-utils": "^9.0.1",
+    "@types/react-helmet": "^6.0.0",
+    "@types/react-loadable": "^5.5.3",
+    "@types/react-router-config": "^5.0.1",
     "@types/semver": "^7.1.0",
     "@types/shelljs": "^0.8.6",
     "@types/webpack": "^4.41.0",
     "@types/webpack-dev-server": "^3.9.0",
     "@types/webpack-merge": "^4.1.5",
+    "@typescript-eslint/eslint-plugin": "^3.3.0",
+    "@typescript-eslint/parser": "^3.3.0",
     "babel-eslint": "^10.0.3",
     "concurrently": "^5.2.0",
     "enzyme": "^3.10.0",
@@ -85,7 +94,7 @@
     "rimraf": "^3.0.2",
     "serve": "^11.3.2",
     "stylelint": "^13.2.1",
-    "typescript": "^3.7.2"
+    "typescript": "^3.9.5"
   },
   "peerDependencies": {
     "stylelint-copyright": "^2.0.0"

packages/docusaurus-1.x/lib/core/utils.js

@@ -64,7 +64,7 @@ function getGitLastUpdated(filepath) {
     const silentState = shell.config.silent; // Save old silent state.
     shell.config.silent = true;
     const result = shell
-      .exec(`git log --follow --summary --format="%ct, %an" ${filepath}`)
+      .exec(`git log --follow --summary --format="%ct, %an" "${filepath}"`)
       .stdout.trim();
     shell.config.silent = silentState;
 

packages/docusaurus-1.x/lib/server/readMetadata.js

@@ -25,6 +25,15 @@ const utils = require('./utils.js');
 
 const docsPart = `${siteConfig.docsUrl ? `${siteConfig.docsUrl}/` : ''}`;
 
+// Get a list of all IDs that have been deleted in any version.
+// We will assume these should not be in the current/next version.
+const allDeletedIds = new Set();
+if (siteConfig.deletedDocs) {
+  Object.values(siteConfig.deletedDocs).forEach((idList) => {
+    idList.forEach((id) => allDeletedIds.add(id));
+  });
+}
+
 const SupportedHeaderFields = new Set([
   'id',
   'title',
@@ -238,6 +247,12 @@ function generateMetadataDocs() {
           return;
         }
         const metadata = res.metadata;
+        if (
+          allDeletedIds.has(metadata.id) ||
+          (metadata.original_id && allDeletedIds.has(metadata.original_id))
+        ) {
+          return;
+        }
         metadatas[metadata.id] = metadata;
 
         // create a default list of documents for each enabled language based on docs in English
@@ -290,6 +305,12 @@ function generateMetadataDocs() {
           return;
         }
         const metadata = res.metadata;
+        if (
+          allDeletedIds.has(metadata.id) ||
+          (metadata.original_id && allDeletedIds.has(metadata.original_id))
+        ) {
+          return;
+        }
         metadatas[metadata.id] = metadata;
       }
     });

packages/docusaurus-1.x/lib/server/versionFallback.js

@@ -115,15 +115,46 @@ function docVersion(id, reqVersion) {
   // iterate through versions until a version less than or equal to the requested
   // is found, then check if that version has an available file to use
   let requestedFound = false;
+  let availableVersion = null;
+  let deletedDocs = null;
+  if (siteConfig.deletedDocs) {
+    // Config file may have either Array or Set for each version. Convert
+    // all to Set to make the check faster in the versions loop below.
+    deletedDocs = {};
+    Object.keys(siteConfig.deletedDocs).forEach((deletedDocVersion) => {
+      deletedDocs[deletedDocVersion] = new Set(
+        siteConfig.deletedDocs[deletedDocVersion],
+      );
+    });
+  }
   for (let i = 0; i < versions.length; i++) {
     if (versions[i] === reqVersion) {
       requestedFound = true;
     }
-    if (requestedFound && available[id].has(versions[i])) {
-      return versions[i];
+    if (requestedFound) {
+      // If this ID is deleted as of any version equal to or prior to
+      // the requested, return null.
+      if (
+        deletedDocs &&
+        deletedDocs[versions[i]] &&
+        deletedDocs[versions[i]].has(id)
+      ) {
+        return null;
+      }
+      if (!availableVersion && available[id].has(versions[i])) {
+        availableVersion = versions[i];
+        // Note the fallback version but keep looping in case this ID
+        // was deleted as of a previous version.
+        //
+        // If `deletedDocs` config isn't used, we can return immediately
+        // and avoid unnecessary looping.
+        if (!deletedDocs) {
+          break;
+        }
+      }
     }
   }
-  return null;
+  return availableVersion;
 }
 
 // returns whether a given file has content that differ from the

packages/docusaurus-init/bin/index.js

@@ -11,7 +11,7 @@ const chalk = require('chalk');
 const semver = require('semver');
 const path = require('path');
 const program = require('commander');
-const {init} = require('../lib');
+const {default: init} = require('../lib');
 const requiredVersion = require('../package.json').engines.node;
 
 if (!semver.satisfies(process.version, requiredVersion)) {

packages/docusaurus-init/package.json

@@ -10,7 +10,7 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "scripts": {
-    "tsc": "tsc",
+    "build": "tsc",
     "watch": "tsc --watch"
   },
   "bin": {

packages/docusaurus-init/src/index.ts

@@ -26,15 +26,18 @@ function isValidGitRepoUrl(gitRepoUrl: string): boolean {
   return ['https://', 'git@'].some((item) => gitRepoUrl.startsWith(item));
 }
 
-async function updatePkg(pkgPath: string, obj: any): Promise<void> {
+async function updatePkg(
+  pkgPath: string,
+  obj: Record<string, unknown>,
+): Promise<void> {
   const content = await fs.readFile(pkgPath, 'utf-8');
   const pkg = JSON.parse(content);
   const newPkg = Object.assign(pkg, obj);
 
   await fs.outputFile(pkgPath, JSON.stringify(newPkg, null, 2));
 }
 
-export async function init(
+export default async function init(
   rootDir: string,
   siteName?: string,
   reqTemplate?: string,

packages/docusaurus-init/templates/bootstrap/package.json

@@ -11,6 +11,7 @@
   "dependencies": {
     "@docusaurus/core": "^2.0.0-alpha.58",
     "@docusaurus/preset-bootstrap": "^2.0.0-alpha.58",
+    "@mdx-js/react": "^1.5.8",
     "classnames": "^2.2.6",
     "react": "^16.8.4",
     "react-dom": "^16.8.4"