Docusaurus v3

.github/workflows/documentation.yml

@@ -16,12 +16,12 @@ jobs:
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - name: Check out repo
-        uses: actions/checkout@v2
+        uses: actions//checkout@v4
       # Node is required for npm
       - name: Set up Node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4.0.2
         with:
-          node-version: "12"
+          node-version: "18"
       # Install and build Docusaurus website
       - name: Build Docusaurus website
         run: |

.github/workflows/npm-publish.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@master
         with:
-          node-version: 12
+          node-version: 18
           # Specifies the registry, this field is required!
           registry-url: https://registry.npmjs.org/
       # clean install of your projects' deps. We use "npm ci" to avoid package lock changes

.github/workflows/pull-request.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [18.x]
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it

docs/Introductions/introductions.md

@@ -48,11 +48,11 @@ yarn add redux-saga-controller --save
 - [clearCtrl](/docs/api-reference/action-creators/clear-ctrl)
 - [updateCtrl](/docs/api-reference/action-creators/update-ctrl)
 
-> ** Controller annotation:**
+> **Controller annotation:**
 - [create](/docs/api-reference/controller/create)
 - [createController](/docs/api-reference/controller/create-controller)
 
-> ** Hooks:**
+> **Hooks:**
 - [useController](/docs/hooks/use-controller)
 - [useControllerData](/docs/hooks/use-controller-data)
 - [useControllerActions](/docs/hooks/use-controller-actions)

docs/readme.md

@@ -6,7 +6,7 @@ sidebar_position: 0
 
 > **Introductions**
 
-- [Info](/docs/Introductions/introductions) 
+- [Info](/docs/Introductions) 
 - [Getting Started](/docs/Introductions/getting-started)
 
 > **Api Reference/Action**

website/.gitignore

@@ -7,6 +7,7 @@
 # Generated files
 .docusaurus
 .cache-loader
+i18n
 
 # Misc
 .DS_Store

website/docusaurus.config.js

@@ -7,19 +7,34 @@ import { themes as prismThemes } from 'prism-react-renderer';
   tagline: 'A tool to simplify work with react, redux and redux-saga',
   url: 'https://redux-saga-controller.js.org',
   baseUrl: '/',
-  onBrokenLinks: 'throw',
+  trailingSlash: false,
+  onBrokenLinks: 'warn',
   onBrokenMarkdownLinks: 'warn',
   favicon: 'img/favicon.ico',
   organizationName: 'TECH-Rubicone',
   projectName: 'redux-saga-controller',
-  trailingSlash: false,
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+    path: 'i18n',
+    localeConfigs: {
+      en: {
+        label: 'English',
+        direction: 'ltr',
+        htmlLang: 'en-US',
+        calendar: 'gregory',
+        path: 'en'
+      }
+    },
+  },
   presets: [
     [
       '@docusaurus/preset-classic',
       /** @type {import('@docusaurus/preset-classic').Options} */
       ({
         docs: {
           path: '../docs',
+          routeBasePath: '/docs', // Serve the docs at the site's root
           sidebarPath: require.resolve('./sidebars.js'),
           // Please change this to your repo.
           editUrl: 'https://github.com/TECH-Rubicone/redux-saga-controller/edit/master/docs/intro.md',
@@ -68,7 +83,7 @@ import { themes as prismThemes } from 'prism-react-renderer';
             items: [
               {
                 label: 'Tutorial',
-                to: '/docs/readme',
+                to: '/docs',
               },
             ],
           },

website/src/pages/index.js

@@ -19,7 +19,7 @@ function HomepageHeader () {
         <h1 className="hero__title">{siteConfig.title}</h1>
         <p className="hero__subtitle">{siteConfig.tagline}</p>
         <div className={styles.buttons}>
-          <Link className="button button--secondary button--lg" to="/docs/readme">
+          <Link className="button button--secondary button--lg" to="/docs">
             Tutorial
           </Link>
         </div>