Merge branch 'main' into add-editor-tools-contrib-page

Author: AucaCoyan

.github/workflows/ci.yml

@@ -5,12 +5,12 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4.1.2
 
       - name: Setup Node
-        uses: actions/setup-node@v3.8.1
+        uses: actions/setup-node@v4.0.2
         with:
-          node-version: '18'
+          node-version: 20
 
       - run: npm install
       # - run: npm run build

.github/workflows/command-block.yml

@@ -8,7 +8,7 @@ jobs:
   comment:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v7.0.1
         with:
           script: |
             github.rest.issues.createComment({
@@ -21,5 +21,3 @@ jobs:
                 '- Else, please look for the command in the [source tree](https://github.com/nushell/nushell/tree/main/crates) and make your changes directly there.\n\n'+
                 'Thanks for helping out!'
             })
-
-

.github/workflows/deploy.yml

@@ -11,15 +11,15 @@ jobs:
     runs-on: ubuntu-latest
     if: ${{ github.event_name == 'push' }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4.1.2
         with:
           ref: main
           fetch-depth: 0
 
       - name: Setup Node
-        uses: actions/setup-node@v3.8.1
+        uses: actions/setup-node@v4.0.2
         with:
-          node-version: '18'
+          node-version: 20
 
       - run: npm install
       - name: Build Static Docs
@@ -28,7 +28,7 @@ jobs:
         run: npm run build
 
       - name: Upload Artifact
-        uses: actions/upload-pages-artifact@v2
+        uses: actions/upload-pages-artifact@v3.0.1
         with:
           path: ./.vuepress/dist
 
@@ -46,4 +46,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2.0.4
+        uses: actions/deploy-pages@v4.0.5

.github/workflows/image-actions.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.2
       - name: Compress Images
         id: calibre
         uses: calibreapp/image-actions@main
@@ -30,7 +30,7 @@ jobs:
           githubToken: ${{ secrets.GITHUB_TOKEN }}
       - name: Create New Pull Request If Needed
         if: steps.calibre.outputs.markdown != ''
-        uses: peter-evans/create-pull-request@v3
+        uses: peter-evans/create-pull-request@v6.0.3
         with:
           title: Compressed Images
           branch-suffix: timestamp

.github/workflows/typos.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Actions Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4.1.2
 
       - name: Check spelling
         uses: crate-ci/typos@master

.vuepress/client.js

@@ -4,7 +4,7 @@
  * https://v2.vuepress.vuejs.org/advanced/cookbook/usage-of-client-config.html
  */
 
-import { defineClientConfig } from '@vuepress/client';
+import { defineClientConfig } from 'vuepress/client';
 import BlogPosts from './components/BlogPosts.vue';
 
 export default defineClientConfig({

.vuepress/config.js

@@ -1,10 +1,12 @@
 import path from 'path';
 import { defineUserConfig } from '@vuepress/cli';
 import { gitPlugin } from '@vuepress/plugin-git';
-import { feedPlugin } from 'vuepress-plugin-feed2';
+import { feedPlugin } from '@vuepress/plugin-feed';
+import { viteBundler } from '@vuepress/bundler-vite';
 import { shikiPlugin } from '@vuepress/plugin-shiki';
 import { defaultTheme } from '@vuepress/theme-default';
-import { sitemapPlugin } from 'vuepress-plugin-sitemap2';
+import { sitemapPlugin } from '@vuepress/plugin-sitemap';
+import { copyCodePlugin } from '@vuepress/plugin-copy-code';
 import { docsearchPlugin } from '@vuepress/plugin-docsearch';
 import { backToTopPlugin } from '@vuepress/plugin-back-to-top';
 import { mediumZoomPlugin } from '@vuepress/plugin-medium-zoom';
@@ -33,10 +35,19 @@ const compareDate = (dateA, dateB) => {
   return dateB.getTime() - dateA.getTime();
 };
 
+// default env from the deploy GitHub action
+// e.g. ciUser = nushell and ciRepo = nushell.github.io
+// both default to undefined if the env is undefined
+const [ciUser, ciRepo] = process.env.GITHUB_REPOSITORY?.split('/') ?? [];
+
 export default defineUserConfig({
+  // set the base URL to ciRepo dir if it's a fork
+  // keep the default root if not
+  base: ciRepo && ciUser !== 'nushell' ? `/${ciRepo}/` : '/',
+  bundler: viteBundler(),
   locales: {
     '/': {
-      lang: 'English',
+      lang: 'en-US',
       title: 'Nushell',
       description: 'A new type of shell.',
     },
@@ -46,17 +57,17 @@ export default defineUserConfig({
       description: '一种新型的Shell',
     },
     '/de/': {
-      lang: 'Deutsch',
+      lang: 'de-DE',
       title: 'Nushell',
       description: 'Eine neue Art von Shell.',
     },
     '/es/': {
-      lang: 'es',
+      lang: 'es-ES',
       title: 'Nushell',
       description: 'Un nuevo tipo de shell.',
     },
     '/ja/': {
-      lang: 'ja',
+      lang: 'ja-JP',
       title: 'Nushell',
       description: '新しいタイプのシェル',
     },
@@ -66,7 +77,7 @@ export default defineUserConfig({
       description: 'Um novo tipo de shell.',
     },
     '/ru': {
-      lang: 'ru',
+      lang: 'ru-RU',
       title: 'Nushell',
       description: 'Новый тип оболочки.',
     },
@@ -91,6 +102,7 @@ export default defineUserConfig({
   },
   // without this, we attempt to prefetch the whole site 😬
   shouldPrefetch: false,
+  colorMode: 'auto',
   theme: defaultTheme({
     repo: 'nushell/nushell',
     repoLabel: 'GitHub',
@@ -134,7 +146,7 @@ export default defineUserConfig({
         navbar: navbarPtBR,
         sidebar: sidebarPtBR,
       },
-      '/ru': {
+      '/ru/': {
         selectText: 'Языки',
         selectLanguageName: 'Русский язык',
         editLinkText: 'Отредактируйте эту страницу на GitHub',
@@ -154,6 +166,13 @@ export default defineUserConfig({
     gitPlugin(),
     backToTopPlugin(),
     mediumZoomPlugin(),
+    copyCodePlugin({
+      locales: {
+        '/': {
+          copy: 'Copy Codes from code block',
+        },
+      },
+    }),
     shikiPlugin({
       theme: 'dark-plus',
       langs: [

.vuepress/configs/sidebar/en.ts

@@ -118,13 +118,13 @@ export const sidebarEn: SidebarConfig = {
       link: '/contributor-book/README.md',
       collapsible: false,
       children: [
-        'README.md',
-        'philosophy',
-        'philosophy_0_80',
-        'commands',
-        'plugins',
-        'plugin_protocol_reference',
-        'parser_and_other_editor_tools.md',
+        '/contributor-book/README.md',
+        '/contributor-book/philosophy',
+        '/contributor-book/philosophy_0_80',
+        '/contributor-book/commands',
+        '/contributor-book/plugins',
+        '/contributor-book/plugin_protocol_reference',
+        '/contributor-book/parser_and_other_editor_tools.md',
       ],
     },
   ],
@@ -133,23 +133,23 @@ export const sidebarEn: SidebarConfig = {
       text: 'Cookbook',
       collapsible: false,
       children: [
-        'README.md',
-        'setup',
-        'help',
-        'system',
-        'parsing',
-        'foreign_shell_scripts',
-        'pattern_matching',
-        'external_completers',
-        'files',
-        'git',
-        'parsing_git_log',
-        'http',
-        'direnv',
-        'ssh_agent',
-        'tables',
-        'polars_v_pandas_v_nushell',
-        'jq_v_nushell',
+        '/cookbook/README.md',
+        '/cookbook/setup',
+        '/cookbook/help',
+        '/cookbook/system',
+        '/cookbook/parsing',
+        '/cookbook/foreign_shell_scripts',
+        '/cookbook/pattern_matching',
+        '/cookbook/external_completers',
+        '/cookbook/files',
+        '/cookbook/git',
+        '/cookbook/parsing_git_log',
+        '/cookbook/http',
+        '/cookbook/direnv',
+        '/cookbook/ssh_agent',
+        '/cookbook/tables',
+        '/cookbook/polars_v_pandas_v_nushell',
+        '/cookbook/jq_v_nushell',
       ],
     },
   ],
@@ -158,7 +158,7 @@ export const sidebarEn: SidebarConfig = {
       text: 'Language Reference Guide',
       link: '/lang-guide/README.md',
       collapsible: false,
-      children: ['README.md', 'lang-guide.md'],
+      children: ['/lang-guide/README.md', '/lang-guide/lang-guide.md'],
     },
   ],
 };

.vuepress/configs/sidebar/es.ts

@@ -6,27 +6,26 @@ export const sidebarEs: SidebarConfig = {
       text: 'Nu Libro',
       collapsible: false,
       children: [
-        'README.md',
-        'instalacion',
-        'explorando',
-        'tipos_de_datos',
-        'cargando_datos', // "trabajando_con_listas"
-        'trabajando_con_tablas',
-        'pipeline',
-        'configuracion', // "custom_commands"
-        'aliases', // "operadores"
-        'matematicas', // "variables_y_subexpresiones"
-        'entorno', // "scripts"
-        'metadatos',
-        'shells_en_shells',
-        'escapando',
-        'plugins', // "dataframes"
-        'llegando_de_bash',
-        'mapa_nushell',
-        'mapa_imperativo_nushell',
-        'mapa_funcional_nushell',
-        'mapa_operador_nushell',
-        '/book/command_reference.md',
+        '/es/book/README.md',
+        '/es/book/instalacion',
+        '/es/book/explorando',
+        '/es/book/tipos_de_datos',
+        '/es/book/cargando_datos', // "trabajando_con_listas"
+        '/es/book/trabajando_con_tablas',
+        '/es/book/pipeline',
+        '/es/book/configuracion', // "custom_commands"
+        '/es/book/aliases', // "operadores"
+        '/es/book/matematicas', // "variables_y_subexpresiones"
+        '/es/book/entorno', // "scripts"
+        '/es/book/metadatos',
+        '/es/book/shells_en_shells',
+        '/es/book/escapando',
+        '/es/book/plugins', // "dataframes"
+        '/es/book/llegando_de_bash',
+        '/es/book/mapa_nushell',
+        '/es/book/mapa_imperativo_nushell',
+        '/es/book/mapa_funcional_nushell',
+        '/es/book/mapa_operador_nushell',
       ],
     },
   ],

.vuepress/configs/sidebar/pt-BR.ts

@@ -6,18 +6,18 @@ export const sidebarPtBR: SidebarConfig = {
       text: 'Nu Livro',
       collapsible: false,
       children: [
-        'instalacao',
-        'introducao',
-        'explorando',
-        'tipos_de_dados',
-        'carregando_dados',
-        'trabalhando_com_tabelas',
-        'pipeline',
-        'line_editor',
-        'metadados',
-        'shells_em_shells',
-        'escapando',
-        'plugins',
+        '/pt-BR/book/instalacao',
+        '/pt-BR/book/introducao',
+        '/pt-BR/book/explorando',
+        '/pt-BR/book/tipos_de_dados',
+        '/pt-BR/book/carregando_dados',
+        '/pt-BR/book/trabalhando_com_tabelas',
+        '/pt-BR/book/pipeline',
+        '/pt-BR/book/line_editor',
+        '/pt-BR/book/metadados',
+        '/pt-BR/book/shells_em_shells',
+        '/pt-BR/book/escapando',
+        '/pt-BR/book/plugins',
       ],
     },
   ],