feat(v2): core v2 i18n support + Docusaurus site Crowdin integration

.eslintignore

@@ -24,6 +24,7 @@ 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-theme-classic/lib-next/
 packages/docusaurus-theme-bootstrap/lib/
 packages/docusaurus-migrate/lib/
 

.gitignore

@@ -28,11 +28,16 @@ packages/docusaurus-plugin-debug/lib/
 packages/docusaurus-plugin-sitemap/lib/
 packages/docusaurus-plugin-ideal-image/lib/
 packages/docusaurus-theme-classic/lib/
+packages/docusaurus-theme-classic/lib-next/
 packages/docusaurus-theme-bootstrap/lib/
 packages/docusaurus-migrate/lib/
 
-website/netlifyDeployPreview
+website/netlifyDeployPreview/*
 !website/netlifyDeployPreview/index.html
 !website/netlifyDeployPreview/_redirects
 
 website-1.x-migrated
+
+website/i18n/**/*
+#!website/i18n/fr
+#!website/i18n/fr/**/*

crowdin-v2.yaml

@@ -0,0 +1,142 @@
+#
+# Your Crowdin credentials
+#
+'project_id': '416738'
+'api_token_env': 'CROWDIN_PERSONAL_TOKEN'
+'base_path': '.'
+'base_url': 'https://api.crowdin.com'
+
+#
+# Choose file structure in Crowdin
+# e.g. true or false
+#
+'preserve_hierarchy': true
+
+#
+# Files configuration
+#
+files:
+  [
+    {
+      'source': '/website/i18n/en/**/*',
+      'translation': '/website/i18n/%two_letters_code%/**/%original_file_name%',
+    },
+    {
+      'source': '/website/docs/**/*',
+      'translation': '/website/i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%',
+    },
+    {
+      'source': '/website/community/**/*',
+      'translation': '/website/i18n/%two_letters_code%/docusaurus-plugin-content-docs-community/current/**/%original_file_name%',
+    },
+    {
+      'source': '/website/versioned_docs/**/*',
+      'translation': '/website/i18n/%two_letters_code%/docusaurus-plugin-content-docs/**/%original_file_name%',
+    },
+    {
+      'source': '/website-1.x/blog/**/*',
+      'translation': '/website/i18n/%two_letters_code%/docusaurus-plugin-content-blog/**/%original_file_name%',
+    },
+    {
+      'source': '/website/src/pages/**/*',
+      'translation': '/website/i18n/%two_letters_code%/docusaurus-plugin-content-pages/**/%original_file_name%',
+      'ignore': ['/**/*.js', '/**/*.jsx', '/**/*.ts', '/**/*.tsx', '/**/*.css'],
+    },
+  ]
+#
+# Source files filter
+# e.g. "/resources/en/*.json"
+#
+#"source" : "/website/docs/**/*.md",
+#
+# Where translations will be placed
+# e.g. "/resources/docs/%two_letters_code%/%original_file_name%"
+#
+#"translation" : "/website/i18n/%language%/docs/current/%original_file_name%",
+#
+# Files or directories for ignore
+# e.g. ["/**/?.txt", "/**/[0-9].txt", "/**/*\?*.txt"]
+#
+#"ignore" : [],
+#
+# The dest allows you to specify a file name in Crowdin
+# e.g. "/messages.json"
+#
+#"dest" : "",
+#
+# File type
+# e.g. "json"
+#
+#"type" : "",
+#
+# The parameter "update_option" is optional. If it is not set, after the files update the translations for changed strings will be removed. Use to fix typos and for minor changes in the source strings
+# e.g. "update_as_unapproved" or "update_without_changes"
+#
+#"update_option" : "",
+#
+# Start block (for XML only)
+#
+#
+# Defines whether to translate tags attributes.
+# e.g. 0 or 1  (Default is 1)
+#
+# "translate_attributes" : 1,
+#
+# Defines whether to translate texts placed inside the tags.
+# e.g. 0 or 1 (Default is 1)
+#
+# "translate_content" : 1,
+#
+# This is an array of strings, where each item is the XPaths to DOM element that should be imported
+# e.g. ["/content/text", "/content/text[@value]"]
+#
+# "translatable_elements" : [],
+#
+# Defines whether to split long texts into smaller text segments
+# e.g. 0 or 1 (Default is 1)
+#
+# "content_segmentation" : 1,
+#
+# End block (for XML only)
+#
+#
+# Start .properties block
+#
+#
+# Defines whether single quote should be escaped by another single quote or backslash in exported translations
+# e.g. 0 or 1 or 2 or 3 (Default is 3)
+# 0 - do not escape single quote;
+# 1 - escape single quote by another single quote;
+# 2 - escape single quote by backslash;
+# 3 - escape single quote by another single quote only in strings containing variables ( {0} ).
+#
+# "escape_quotes" : 3,
+#
+# Defines whether any special characters (=, :, ! and #) should be escaped by backslash in exported translations.
+# e.g. 0 or 1 (Default is 0)
+# 0 - do not escape special characters
+# 1 - escape special characters by a backslash
+#
+# "escape_special_characters": 0
+#
+#
+# End .properties block
+#
+#
+# Often software projects have custom names for the directories where translations are placed. crowdin-cli allows you to map your own languages to be understandable by Crowdin.
+#
+#"languages_mapping" : {
+#  "two_letters_code" : {
+#    "crowdin_language_code" : "local_name"
+#   }
+#},
+#
+# Does the first line contain header?
+# e.g. true or false
+#
+#"first_line_contains_header" : true,
+#
+# for spreadsheets
+# e.g. "identifier,source_phrase,context,uk,ru,fr"
+#
+# "scheme" : "",

examples/bootstrap/docs/doc1.md

@@ -29,9 +29,9 @@ To serve as an example page when styling markdown based Docusaurus sites.
 
 ## Emphasis
 
-Emphasis, aka italics, with *asterisks* or _underscores_.
+Emphasis, aka italics, with _asterisks_ or _underscores_.
 
-Strong emphasis, aka bold, with **asterisks** or __underscores__.
+Strong emphasis, aka bold, with **asterisks** or **underscores**.
 
 Combined emphasis with **asterisks and _underscores_**.
 
@@ -48,11 +48,11 @@ Strikethrough uses two tildes. ~~Scratch this.~~
    1. Ordered sub-list
 1. And another item.
 
-* Unordered list can use asterisks
+- Unordered list can use asterisks
 
-- Or minuses
+* Or minuses
 
-+ Or pluses
+- Or pluses
 
 ---
 
@@ -92,7 +92,6 @@ Images from any folder can be used by providing path to file. Path should be rel
 
 ![img](../static/img/logo.svg)
 
-
 ---
 
 ## Code

examples/classic/docs/doc1.md

@@ -29,9 +29,9 @@ To serve as an example page when styling markdown based Docusaurus sites.
 
 ## Emphasis
 
-Emphasis, aka italics, with *asterisks* or _underscores_.
+Emphasis, aka italics, with _asterisks_ or _underscores_.
 
-Strong emphasis, aka bold, with **asterisks** or __underscores__.
+Strong emphasis, aka bold, with **asterisks** or **underscores**.
 
 Combined emphasis with **asterisks and _underscores_**.
 
@@ -48,11 +48,11 @@ Strikethrough uses two tildes. ~~Scratch this.~~
    1. Ordered sub-list
 1. And another item.
 
-* Unordered list can use asterisks
+- Unordered list can use asterisks
 
-- Or minuses
+* Or minuses
 
-+ Or pluses
+- Or pluses
 
 ---
 

examples/facebook/docs/doc1.md

@@ -29,9 +29,9 @@ To serve as an example page when styling markdown based Docusaurus sites.
 
 ## Emphasis
 
-Emphasis, aka italics, with *asterisks* or _underscores_.
+Emphasis, aka italics, with _asterisks_ or _underscores_.
 
-Strong emphasis, aka bold, with **asterisks** or __underscores__.
+Strong emphasis, aka bold, with **asterisks** or **underscores**.
 
 Combined emphasis with **asterisks and _underscores_**.
 
@@ -48,11 +48,11 @@ Strikethrough uses two tildes. ~~Scratch this.~~
    1. Ordered sub-list
 1. And another item.
 
-* Unordered list can use asterisks
+- Unordered list can use asterisks
 
-- Or minuses
+* Or minuses
 
-+ Or pluses
+- Or pluses
 
 ---
 

package.json

@@ -29,6 +29,8 @@
     "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",
+    "crowdin:upload:v2": "crowdin upload sources --config ./crowdin-v2.yaml",
+    "crowdin:download:v2": "crowdin download --config ./crowdin-v2.yaml",
     "changelog": "lerna-changelog",
     "postinstall": "yarn lock:update && yarn build:packages",
     "prettier": "prettier --config .prettierrc --write \"**/*.{js,ts}\"",

packages/docusaurus-1.x/lib/server/__tests__/utils.test.js

@@ -40,7 +40,7 @@ describe('server utils', () => {
     expect(css).toMatchSnapshot();
 
     await expect(utils.minifyCss(notCss)).rejects.toMatchSnapshot();
-  });
+  }, 10000);
 
   test('autoprefix css', async () => {
     const testCss = fs.readFileSync(

packages/docusaurus-module-type-aliases/src/index.d.ts

@@ -47,6 +47,20 @@ declare module '@generated/globalData' {
   export default globalData;
 }
 
+declare module '@generated/i18n' {
+  const i18n: {
+    defaultLocale: string;
+    locales: [string, ...string[]];
+    currentLocale: string;
+  };
+  export default i18n;
+}
+
+declare module '@generated/codeTranslations' {
+  const codeTranslations: Record<string, string>;
+  export default codeTranslations;
+}
+
 declare module '@theme/*';
 
 declare module '@theme-original/*';
@@ -69,6 +83,18 @@ declare module '@docusaurus/Link' {
   export default Link;
 }
 
+declare module '@docusaurus/Translate' {
+  type TranslateProps = {children: string; id?: string; description?: string};
+  const Translate: (props: TranslateProps) => JSX.Element;
+  export default Translate;
+
+  export function translate(param: {
+    message: string;
+    id?: string;
+    description?: string;
+  }): string;
+}
+
 declare module '@docusaurus/router' {
   export const Redirect: (props: {to: string}) => import('react').Component;
   export function matchPath(

packages/docusaurus-plugin-client-redirects/src/index.ts

@@ -14,7 +14,7 @@ import writeRedirectFiles, {
   toRedirectFilesMetadata,
   RedirectFileMetadata,
 } from './writeRedirectFiles';
-import {removePrefix} from '@docusaurus/utils';
+import {removePrefix, addLeadingSlash} from '@docusaurus/utils';
 
 export default function pluginClientRedirectsPages(
   _context: LoadContext,
@@ -27,7 +27,7 @@ export default function pluginClientRedirectsPages(
     async postBuild(props: Props) {
       const pluginContext: PluginContext = {
         relativeRoutesPaths: props.routesPaths.map(
-          (path) => `/${removePrefix(path, props.baseUrl)}`,
+          (path) => `${addLeadingSlash(removePrefix(path, props.baseUrl))}`,
         ),
         baseUrl: props.baseUrl,
         outDir: props.outDir,

packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/blog-with-ref/post-with-broken-links.md

@@ -0,0 +1,11 @@
+---
+title: This post links to another one!
+---
+
+[Good link 1](2018-12-14-Happy-First-Birthday-Slash.md)
+
+[Good link 2](./2018-12-14-Happy-First-Birthday-Slash.md)
+
+[Bad link 1](postNotExist1.md)
+
+[Bad link 1](./postNotExist2.mdx)

packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/linkify.test.ts.snap

@@ -1,5 +1,20 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`report broken markdown links 1`] = `
+"---
+title: This post links to another one!
+---
+
+[Good link 1](/blog/2018/12/14/Happy-First-Birthday-Slash)
+
+[Good link 2](/blog/2018/12/14/Happy-First-Birthday-Slash)
+
+[Bad link 1](postNotExist1.md)
+
+[Bad link 1](./postNotExist2.mdx)
+"
+`;
+
 exports[`transform to correct link 1`] = `
 "---
 title: This post links to another one!