Merge remote-tracking branch 'template/main'

Author: rodber

.github/workflows/build.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       matrix:
         operating-system: [ubuntu-latest]
-        php-versions: ["8.0"]
+        php-versions: ["8.2"]
     env:
       extensions: opcache, mbstring, ds, pcov
       tools: composer
@@ -40,7 +40,7 @@ jobs:
           key: ${{ env.key }}
 
       - name: Cache extensions
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ${{ steps.extcache.outputs.dir }}
           key: ${{ steps.extcache.outputs.key }}
@@ -68,7 +68,7 @@ jobs:
         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
 
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
@@ -87,14 +87,17 @@ jobs:
         id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn cache dir)"
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         id: yarn-cache
         with:
           path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
           key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
             ${{ runner.os }}-yarn-
 
+      - name: Show dir contents
+        run: ls -la docs/.vuepress
+
       - name: vuepress-deploy
         uses: jenkey2011/vuepress-deploy@v1
         env:

.github/workflows/update-template.yml

@@ -3,13 +3,16 @@ on:
   workflow_dispatch:
 jobs:
   update-template:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+      pull-requests: write
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: actions-template-sync
-        uses: AndreasAugustin/actions-template-sync@v0.1.3-draft
+        uses: AndreasAugustin/actions-template-sync@v2
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          source_gh_token: ${{ secrets.GITHUB_TOKEN }}
           source_repo_path: chevere/docs-deploy
           upstream_branch: main

.header

@@ -2,30 +2,49 @@ const project = require('./config-project')
 
 project.theme = 'default-prefers-color-scheme';
 project.head.push(
-    ['meta', { 
+    ['meta', {
         name: 'viewport',
         content: 'width=device-width, initial-scale=1.0'
     }]
 );
-
+if (!project.themeConfig) {
+    project.themeConfig = {};
+}
+if (!project.themeConfig.nav) {
+    project.themeConfig.nav = [];
+}
 if (!project.plugins) {
     project.plugins = [];
 }
 project.plugins.push(
-    ['@vuepress/pwa', {
-        serviceWorker: true,
-        updatePopup: true
-    }],
-    ['@vuepress/medium-zoom', true]
+    ['@vuepress/medium-zoom', true],
+    ['seo', project.themeConfig.seo || {}]
 );
-if (!project.themeConfig.nav) {
-    project.themeConfig.nav = [];
+if (project.themeConfig.nav_before) {
+    project.themeConfig.nav.unshift(
+        ...project.themeConfig.nav_before
+    );
 }
 project.themeConfig.nav.push(
     ...require('./nav/en')
 );
+if (project.themeConfig.nav_after) {
+    project.themeConfig.nav.push(
+        ...project.themeConfig.nav_after
+    );
+}
 if (!project.themeConfig.sidebar) {
     project.themeConfig.sidebar = [];
 }
+project.chainWebpack = (config) => {
+    config.module
+      .rule('webp')
+      .test(/\.webp$/)
+      .use('file-loader')
+      .loader('file-loader')
+      .options({
+        name: 'assets/img/[name].[hash:8].[ext]'
+      });
+}
 project.themeConfig.sidebar = require('./sidebar/en');
-module.exports = project
+module.exports = project

.vuepress/config.js

@@ -0,0 +1,22 @@
+/**
+ * Client app enhancement file.
+ *
+ * https://v1.vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements
+ */
+
+export default ({
+    Vue, // the version of Vue being used in the VuePress app
+    options, // the options for the root Vue instance
+    router, // the router instance for the app
+    siteData // site metadata
+  }) => {
+    // ...apply enhancements to the app
+    try {
+        const enhanceAppProject = require('./enhanceApp-project.js').default;
+        enhanceAppProject({ router });
+      } catch (error) {
+        // If the file doesn't exist, do nothing
+      }
+  }
+
+

.vuepress/enhanceApp.js

@@ -4,6 +4,14 @@
  * ref：https://vuepress.vuejs.org/config/#index-styl
  */
 
+ .float-left {
+    float:left;
+}
+
+.margin-1em {
+    margin: 1em;
+}
+
 .home .hero img
   max-width 450px!important
 
@@ -26,4 +34,53 @@ h1, h2, h3, h4, h5, h6,
         border-color $borderColor !important
 
 .theme-code-group .theme-code-group__nav .theme-code-group__nav-tab
-    color var(--preTextColor) !important
+    color var(--preTextColor) !important
+
+.theme-default-content code
+    font-size 0.93em
+
+code, kbd, .line-number
+  font-family "FiraCode Nerd Font", "Operator Mono", Inconsolata, source-code-pro, Menlo, Monaco, Consolas, "Courier New", monospace
+
+.embed-responsive {
+    position: relative;
+    display: block;
+    width: 100%;
+    padding: 0;
+    overflow: hidden
+}
+
+.embed-responsive:before {
+    display: block;
+    content: ""
+}
+
+.embed-responsive .embed-responsive-item,.embed-responsive embed,.embed-responsive iframe,.embed-responsive object,.embed-responsive video {
+    position: absolute;
+    top: 0;
+    bottom: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+    border: 0
+}
+
+.embed-responsive-21by9:before {
+    padding-top: 42.857143%
+}
+
+.embed-responsive-16by9:before {
+    padding-top: 56.25%
+}
+
+.embed-responsive-4by3:before {
+    padding-top: 75%
+}
+
+.embed-responsive-1by1:before {
+    padding-top: 100%
+}
+
+a > span {
+    display: inline-block;
+}

.vuepress/styles/default-index.styl

@@ -7,4 +7,6 @@
 $codeBgLightColor = $codeBgColor
 $preTextLightColor = $preTextColor
 $languageTextLightColor = $languageTextColor
-$lineNumbersLightColor = $lineNumbersColor
+$lineNumbersLightColor = $lineNumbersColor
+$accentColor = #006edb
+$accentDarkColor = #2B73DE

.vuepress/styles/default-palette.styl

@@ -64,7 +64,9 @@ The `.vuepress/` folder is required to config VuePress.
 
 * `config-project.js`
   * Injects config values to `config.js`
+* `enhanceApp-project.js`
+  * Injects custom Vue components to the VuePress app
 * `public/`
   * Use it for public content such as pics, icons and the manifest file. A file at `.vuepress/public/logo.svg` will resolve to `/logo.svg`
-* `styles/`  
+* `styles/`
   * Uses to store styling (CSS) properties.

MARKDOWN.md

@@ -13,13 +13,12 @@
 
 use DocsDeploy\BuildController;
 
+use function Chevere\Parameter\arguments;
+
 require 'vendor/autoload.php';
 
 (new BuildController())
     ->run(
-        (new BuildController())
-            ->getArguments(
-                dir: getcwd() . '/docs/',
-                stream: 'php://stdout',
-            )
+        dir: getcwd() . '/docs/',
+        stream: 'php://stdout',
     );

build.php

@@ -18,12 +18,12 @@
         }
     },
     "require": {
-        "chevere/chevere": "^0.3"
+        "chevere/chevere": "^3.2"
     },
     "require-dev": {
-        "symplify/easy-coding-standard": "^9.1",
+        "chevere/var-dump": "^0.9.0",
         "phpunit/phpunit": "^9.5",
-        "chevere/xr": "^0.1"
+        "symplify/easy-coding-standard": "^9.1"
     },
     "config": {
         "optimize-autoloader": true,