Update to Docusaurus v3 (#3518)

* prep * update deps * builds?? * fix deps * switch back to Algolia search #2253 switched to local search but that doesn't work with Docusaurus v3. Switch back to Algolia search * fix mdx build issues * fmt:write * write translations * use docusaurus preset * contextualSearch & fmt * npm run write-translations
yewstack · Nov 5, 2023 · 00a6183 · 00a6183
1 parent 9150005
commit 00a6183
Show file tree

Hide file tree

Showing 52 changed files with 7,474 additions and 4,236 deletions.
diff --git a/.github/workflows/build-website.yml b/.github/workflows/build-website.yml
@@ -25,7 +25,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v4
         with:
-          node-version: "16"
+          node-version: "18"
 
       - name: Install dependencies
         run: |

diff --git a/website/docs/getting-started/build-a-sample-app.mdx b/website/docs/getting-started/build-a-sample-app.mdx
@@ -115,7 +115,7 @@ fn main() {
 Finally, add an `index.html` file in the root directory of your app.
 
 ```html , title=index.html
-<!DOCTYPE html>
+<!doctype html>
 <html>
     <head>
         <meta charset="utf-8" />

diff --git a/website/docs/getting-started/examples.mdx b/website/docs/getting-started/examples.mdx
@@ -9,7 +9,7 @@ We also welcome Pull Requests and issues for when they inevitably get neglected
 For more details including a list of examples, refer to the [README].
 
 :::note
-Most of the examples have a live deployment that can be found at https://examples.yew.rs/<example_name>.
+Most of the examples have a live deployment that can be found at https://examples.yew.rs/< example_name >.
 Click the shield on their README page in their respective sub-folder to navigate to the live demo.
 :::
 

diff --git a/website/docs/tutorial/index.mdx b/website/docs/tutorial/index.mdx
@@ -105,7 +105,7 @@ fn main() {
 Now, let's create an `index.html` at the root of the project.
 
 ```html title="index.html"
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
     <head></head>
     <body></body>

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -119,33 +119,47 @@ module.exports = {
         prism: {
             additionalLanguages: ['rust', 'toml'],
         },
-        gtag: {
-            trackingID: 'G-DENCL8P4YP',
-            anonymizeIP: true,
+        algolia: {
+            appId: 'F8S2ICRD2T',
+            apiKey: '2dc337d68f84389c3713a393aff39816',
+            indexName: 'yew-rs',
+            contextualSearch: true,
+            insights: true, // Optional, automatically send insights when user interacts with search results
+            searchPagePath: 'search',
         },
     },
     i18n: {
         defaultLocale: 'en',
         locales: ['en', 'ja', 'zh-Hans', 'zh-Hant'],
     },
-    plugins: [
-        'content-pages',
-        'docusaurus-plugin-sass',
-        [
-            '@docusaurus/theme-classic',
-            {
-                customCss: require.resolve('./src/css/custom.css'),
-            },
-        ],
+    presets: [
         [
-            '@docusaurus/plugin-content-docs',
+            '@docusaurus/preset-classic',
             {
-                path: 'docs',
-                sidebarPath: require.resolve('./sidebars/docs.js'),
-                editUrl,
-                routeBasePath: '/docs',
+                theme: {
+                    customCss: ['./src/css/custom.css'],
+                },
+                docs: {
+                    path: 'docs',
+                    sidebarPath: require.resolve('./sidebars/docs.js'),
+                    editUrl,
+                    routeBasePath: '/docs',
+                },
+                blog: {
+                    path: 'blog',
+                    blogTitle: 'Yew Blog',
+                    editUrl,
+                },
+                pages: {},
+                gtag: {
+                    trackingID: 'G-DENCL8P4YP',
+                    anonymizeIP: true,
+                },
             },
         ],
+    ],
+    plugins: [
+        'docusaurus-plugin-sass',
         [
             '@docusaurus/plugin-content-docs',
             {
@@ -156,14 +170,6 @@ module.exports = {
                 editUrl,
             },
         ],
-        [
-            '@docusaurus/plugin-content-blog',
-            {
-                path: 'blog',
-                blogTitle: 'Yew Blog',
-                editUrl,
-            },
-        ],
         [
             'client-redirects',
             {
@@ -177,12 +183,5 @@ module.exports = {
                 ],
             },
         ],
-        [
-            '@easyops-cn/docusaurus-search-local',
-            {
-                hashed: true,
-                indexBlog: false,
-            },
-        ],
     ],
 }
diff --git a/website/i18n/ja/code.json b/website/i18n/ja/code.json
@@ -295,5 +295,133 @@
   "theme.docs.sidebar.toggleSidebarButtonAriaLabel": {
     "message": "Toggle navigation bar",
     "description": "The ARIA label for hamburger menu button of mobile navigation"
+  },
+  "theme.admonition.warning": {
+    "message": "警告",
+    "description": "The default label used for the Warning admonition (:::warning)"
+  },
+  "theme.DocSidebarItem.expandCategoryAriaLabel": {
+    "message": "Expand sidebar category '{label}'",
+    "description": "The ARIA label to expand the sidebar category"
+  },
+  "theme.DocSidebarItem.collapseCategoryAriaLabel": {
+    "message": "Collapse sidebar category '{label}'",
+    "description": "The ARIA label to collapse the sidebar category"
+  },
+  "theme.unlistedContent.title": {
+    "message": "Unlisted page",
+    "description": "The unlisted content banner title"
+  },
+  "theme.unlistedContent.message": {
+    "message": "This page is unlisted. Search engines will not index it, and only users having a direct link can access it.",
+    "description": "The unlisted content banner message"
+  },
+  "theme.SearchPage.inputPlaceholder": {
+    "message": "検索するキーワードを入力してください",
+    "description": "The placeholder for search page input"
+  },
+  "theme.SearchPage.inputLabel": {
+    "message": "検索",
+    "description": "The ARIA label for search page input"
+  },
+  "theme.SearchPage.algoliaLabel": {
+    "message": "Algoliaで検索",
+    "description": "The ARIA label for Algolia mention"
+  },
+  "theme.SearchPage.fetchingNewResults": {
+    "message": "新しい検索結果を取得しています...",
+    "description": "The paragraph for fetching new search results"
+  },
+  "theme.SearchModal.searchBox.resetButtonTitle": {
+    "message": "クリア",
+    "description": "The label and ARIA label for search box reset button"
+  },
+  "theme.SearchModal.searchBox.cancelButtonText": {
+    "message": "キャンセル",
+    "description": "The label and ARIA label for search box cancel button"
+  },
+  "theme.SearchModal.startScreen.recentSearchesTitle": {
+    "message": "最近の検索",
+    "description": "The title for recent searches"
+  },
+  "theme.SearchModal.startScreen.noRecentSearchesText": {
+    "message": "最近の検索履歴はありません",
+    "description": "The text when no recent searches"
+  },
+  "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": {
+    "message": "この検索をお気に入りに追加",
+    "description": "The label for save recent search button"
+  },
+  "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": {
+    "message": "この検索を履歴から削除",
+    "description": "The label for remove recent search button"
+  },
+  "theme.SearchModal.startScreen.favoriteSearchesTitle": {
+    "message": "お気に入り",
+    "description": "The title for favorite searches"
+  },
+  "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": {
+    "message": "この検索をお気に入りから削除",
+    "description": "The label for remove favorite search button"
+  },
+  "theme.SearchModal.errorScreen.titleText": {
+    "message": "検索結果の取得に失敗しました",
+    "description": "The title for error screen of search modal"
+  },
+  "theme.SearchModal.errorScreen.helpText": {
+    "message": "ネットワーク接続を確認してください",
+    "description": "The help text for error screen of search modal"
+  },
+  "theme.SearchModal.footer.selectText": {
+    "message": "選ぶ",
+    "description": "The explanatory text of the action for the enter key"
+  },
+  "theme.SearchModal.footer.selectKeyAriaLabel": {
+    "message": "エンターキー",
+    "description": "The ARIA label for the Enter key button that makes the selection"
+  },
+  "theme.SearchModal.footer.navigateText": {
+    "message": "移動",
+    "description": "The explanatory text of the action for the Arrow up and Arrow down key"
+  },
+  "theme.SearchModal.footer.navigateUpKeyAriaLabel": {
+    "message": "上矢印キー",
+    "description": "The ARIA label for the Arrow up key button that makes the navigation"
+  },
+  "theme.SearchModal.footer.navigateDownKeyAriaLabel": {
+    "message": "下矢印キー",
+    "description": "The ARIA label for the Arrow down key button that makes the navigation"
+  },
+  "theme.SearchModal.footer.closeText": {
+    "message": "閉じる",
+    "description": "The explanatory text of the action for Escape key"
+  },
+  "theme.SearchModal.footer.closeKeyAriaLabel": {
+    "message": "エスケープキー",
+    "description": "The ARIA label for the Escape key button that close the modal"
+  },
+  "theme.SearchModal.footer.searchByText": {
+    "message": "検索",
+    "description": "The text explain that the search is making by Algolia"
+  },
+  "theme.SearchModal.noResultsScreen.noResultsText": {
+    "message": "見つかりませんでした",
+    "description": "The text explains that there are no results for the following search"
+  },
+  "theme.SearchModal.noResultsScreen.suggestedQueryText": {
+    "message": "次の検索を試す:",
+    "description": "The text for the suggested query when no results are found for the following search"
+  },
+  "theme.SearchModal.noResultsScreen.reportMissingResultsText": {
+    "message": "よりよい検索結果がありますか?",
+    "description": "The text for the question where the user thinks there are missing results"
+  },
+  "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": {
+    "message": "報告する",
+    "description": "The text for the link to report missing results"
+  },
+  "theme.SearchModal.placeholder": {
+    "message": "ドキュメントを検索",
+    "description": "The placeholder of the input of the DocSearch pop-up modal"
   }
 }
diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/version-0.18.0.json b/website/i18n/ja/docusaurus-plugin-content-docs/version-0.18.0.json
@@ -38,5 +38,41 @@
   "sidebar.sidebar.category.More": {
     "message": "More",
     "description": "The label for category More in sidebar sidebar"
+  },
+  "sidebar.docs.category.Getting Started": {
+    "message": "Getting Started",
+    "description": "The label for category Getting Started in sidebar docs"
+  },
+  "sidebar.docs.category.Project Setup": {
+    "message": "Project Setup",
+    "description": "The label for category Project Setup in sidebar docs"
+  },
+  "sidebar.docs.category.Concepts": {
+    "message": "Concepts",
+    "description": "The label for category Concepts in sidebar docs"
+  },
+  "sidebar.docs.category.Components": {
+    "message": "Components",
+    "description": "The label for category Components in sidebar docs"
+  },
+  "sidebar.docs.category.wasm-bindgen": {
+    "message": "wasm-bindgen",
+    "description": "The label for category wasm-bindgen in sidebar docs"
+  },
+  "sidebar.docs.category.HTML": {
+    "message": "HTML",
+    "description": "The label for category HTML in sidebar docs"
+  },
+  "sidebar.docs.category.Services": {
+    "message": "Services",
+    "description": "The label for category Services in sidebar docs"
+  },
+  "sidebar.docs.category.Advanced topics": {
+    "message": "Advanced topics",
+    "description": "The label for category Advanced topics in sidebar docs"
+  },
+  "sidebar.docs.category.More": {
+    "message": "More",
+    "description": "The label for category More in sidebar docs"
   }
 }
diff --git a/...aurus-plugin-content-docs/version-0.18.0/getting-started/choose-web-library.mdx b/...aurus-plugin-content-docs/version-0.18.0/getting-started/choose-web-library.mdx
@@ -85,9 +85,8 @@ window.alert("hello from wasm!");
             </td>
             <td style={{ textAlign: 'left' }}>
                 しばしば<code>Result</code>
-                を返さずpanicするようになっている。例えば <code>
-                    stdweb::web::window()
-                </code>
+                を返さずpanicするようになっている。例えば
+                <code>stdweb::web::window()</code>
                 ワーカーの中で呼ばれるパニックする。
             </td>
         </tr>

diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/version-0.19.0.json b/website/i18n/ja/docusaurus-plugin-content-docs/version-0.19.0.json
@@ -54,5 +54,57 @@
   "sidebar.sidebar.category.yew-router": {
     "message": "yew-router",
     "description": "The label for category yew-router in sidebar sidebar"
+  },
+  "sidebar.docs.category.Getting Started": {
+    "message": "Getting Started",
+    "description": "The label for category Getting Started in sidebar docs"
+  },
+  "sidebar.docs.category.Project Setup": {
+    "message": "Project Setup",
+    "description": "The label for category Project Setup in sidebar docs"
+  },
+  "sidebar.docs.category.Concepts": {
+    "message": "Concepts",
+    "description": "The label for category Concepts in sidebar docs"
+  },
+  "sidebar.docs.category.wasm-bindgen": {
+    "message": "wasm-bindgen",
+    "description": "The label for category wasm-bindgen in sidebar docs"
+  },
+  "sidebar.docs.category.Components": {
+    "message": "Components",
+    "description": "The label for category Components in sidebar docs"
+  },
+  "sidebar.docs.category.HTML": {
+    "message": "HTML",
+    "description": "The label for category HTML in sidebar docs"
+  },
+  "sidebar.docs.category.Function Components": {
+    "message": "Function Components",
+    "description": "The label for category Function Components in sidebar docs"
+  },
+  "sidebar.docs.category.Advanced topics": {
+    "message": "Advanced topics",
+    "description": "The label for category Advanced topics in sidebar docs"
+  },
+  "sidebar.docs.category.More": {
+    "message": "More",
+    "description": "The label for category More in sidebar docs"
+  },
+  "sidebar.docs.category.Migration guides": {
+    "message": "Migration guides",
+    "description": "The label for category Migration guides in sidebar docs"
+  },
+  "sidebar.docs.category.yew": {
+    "message": "yew",
+    "description": "The label for category yew in sidebar docs"
+  },
+  "sidebar.docs.category.yew-agent": {
+    "message": "yew-agent",
+    "description": "The label for category yew-agent in sidebar docs"
+  },
+  "sidebar.docs.category.yew-router": {
+    "message": "yew-router",
+    "description": "The label for category yew-router in sidebar docs"
   }
 }