build: add crowdin support for i18n

Author: gotson

.github/workflows/deploy.yml

@@ -18,6 +18,7 @@ jobs:
         run: |
           yarn install --frozen-lockfile
           yarn run remote-download
+          yarn run crowdin:sync
           yarn build
 
       # Popular action to deploy to GitHub Pages:

.gitignore

@@ -4,6 +4,9 @@
 # Production
 /build
 
+# i18n
+/i18n
+
 # IDE
 .idea
 

crowdin.yml

@@ -0,0 +1,15 @@
+project_id: '493041'
+api_token_env: CROWDIN_PERSONAL_TOKEN
+preserve_hierarchy: true
+files:
+  # JSON translation files
+  - source: /i18n/en/**/*
+    translation: /i18n/%two_letters_code%/**/%original_file_name%
+  # Docs Markdown files
+  - source: /docs/**/*
+    translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%
+    ignore:
+      - /docs/**/_remote
+  # Blog Markdown files
+#  - source: /blog/**/*
+#    translation: /i18n/%two_letters_code%/docusaurus-plugin-content-blog/**/%original_file_name%

docusaurus.config.js

@@ -3,6 +3,8 @@
 
 const lightCodeTheme = require('prism-react-renderer/themes/github')
 const darkCodeTheme = require('prism-react-renderer/themes/dracula')
+const DefaultLocale = 'en';
+
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -18,10 +20,10 @@ const config = {
     deploymentBranch: 'gh-pages',
     trailingSlash: false,
 
-    // i18n: {
-    //   defaultLocale: 'en',
-    //   locales: ['en', 'fr'],
-    // },
+    i18n: {
+        defaultLocale: 'en',
+        locales: ['en', 'fr'],
+    },
 
     plugins: [
         [
@@ -57,8 +59,13 @@ const config = {
             ({
                 docs: {
                     sidebarPath: require.resolve('./sidebars.js'),
-                    // Please change this to your repo.
-                    editUrl: 'https://github.com/anansi-project/anansi-project.github.io/edit/main/',
+                    editUrl: ({locale, docPath}) => {
+                        // Link to Crowdin
+                        if (locale !== DefaultLocale) {
+                            return `https://crowdin.com/project/anansi-project/${locale}`;
+                        }
+                        return `https://github.com/anansi-project/anansi-project.github.io/edit/main/docs/${docPath}`;
+                    },
                 },
                 // blog: {
                 //     showReadingTime: true,
@@ -90,10 +97,10 @@ const config = {
                         label: 'Documentation',
                     },
                     // { to: '/blog', label: 'Blog', position: 'left' },
-                    // {
-                    //   type: 'localeDropdown',
-                    //   position: 'right',
-                    // },
+                    {
+                        type: 'localeDropdown',
+                        position: 'right',
+                    },
                     {
                         href: 'https://github.com/anansi-project',
                         label: 'GitHub',

package.json

@@ -14,9 +14,12 @@
     "write-heading-ids": "docusaurus write-heading-ids",
     "typecheck": "tsc",
     "remote-download": "docusaurus download-remote-comicinfo && docusaurus download-remote-opds-pse",
-    "remote-clear": "docusaurus clear-remote-comicinfo && docusaurus clear-remote-opds-pse"
+    "remote-clear": "docusaurus clear-remote-comicinfo && docusaurus clear-remote-opds-pse",
+    "crowdin": "crowdin",
+    "crowdin:sync": "docusaurus write-translations && crowdin upload && crowdin download"
   },
   "dependencies": {
+    "@crowdin/cli": "3",
     "@docusaurus/core": "2.0.0-beta.13",
     "@docusaurus/preset-classic": "2.0.0-beta.13",
     "@mdx-js/react": "^1.6.21",

yarn.lock

@@ -1162,6 +1162,13 @@
     "@babel/helper-validator-identifier" "^7.15.7"
     to-fast-properties "^2.0.0"
 
+"@crowdin/cli@3":
+  version "3.7.4"
+  resolved "https://registry.yarnpkg.com/@crowdin/cli/-/cli-3.7.4.tgz#5600d8c90d4416325a166fe0cbe339340cebd3af"
+  integrity sha512-gxoJvxq282PWdCQvNRH03wWqBwEXJYlM2aBng5ZbffHLQXVQw7idIeghYJ/7TTwzyXkibq06YPkgAaaJJaoLiw==
+  dependencies:
+    shelljs "^0.8.4"
+
 "@docsearch/[email protected]":
   version "3.0.0-alpha.42"
   resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-3.0.0-alpha.42.tgz#deb6049e999d6ca9451eba4793cb5b6da28c8773"