rspress-plugin-gh-pages 0.1.1 → 0.1.3

package/README.md

@@ -27,3 +27,20 @@ export default defineConfig({
   ],
 });
 ```
+
+## Configure
+
+## repo
+
+- Type: `string`
+- `Required`
+
+The repository to deploy to, you can also specify another repository to deploy to.
+
+## siteBase
+
+- Type: `string`
+
+Deploying to repositories other than the `<user>.github.io` repository requires specifying the `siteBase` option, as an example, deploying to repository `<user>/awesome-plugins` will require setting `siteBase` to `/awesome-plugins`, as the page will be hosted at `https://<user>.github.io/awesome-plugins`.
+
+By default, `rspress-plugin-gh-pages` will try to parse the `repo` option to get a `siteBase` value(if repo is a `github.io` repository, the `siteBase` will be `/`, otherwise, the `siteBase` will be `/<repo-name>`), you can also specify the `siteBase` option to override the default value.

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 import ghpages from 'gh-pages';
 import type { MarkRequired } from 'rspress-plugin-devkit';
 import type { RspressPlugin } from '@rspress/shared';
-export declare const componentsPath: string;
 interface RspressPluginGHPagesOptions extends MarkRequired<ghpages.PublishOptions, 'repo'> {
     directory?: string;
     silent?: boolean;

package/dist/index.js

@@ -1,23 +1,29 @@
-import path from 'node:path';
 import chalk from 'chalk';
 import ghpages from 'gh-pages';
 import { logger } from '@rspress/shared/logger';
-export const componentsPath = path.join(__dirname, './components');
 const DefaultDocBuildOutput = 'doc_build';
 const logPrefix = chalk.green('[gh-pages]');
+function normalizeBase(base) {
+    return base === '/' || base === ''
+        ? '/'
+        : `/${base.replace(/^\/+|\/+$/g, '')}/`;
+}
 export default function rspressPluginGHPages(options) {
     const { repo, directory, branch = 'gh-pages', silent = false, siteBase = '', ...publishOptions } = options;
     return {
         name: 'rspress-plugin-gh-pages',
         config(config) {
             var _a;
+            let baseFromRepo = repo.includes('github.io')
+                ? '/'
+                : (_a = /\/([^\/]+)\.git$/.exec(repo)) === null || _a === void 0 ? void 0 : _a[1];
             // Use || here to as ?? will consider '' as a valid value
-            const base = siteBase || ((_a = /\/([^\/]+)\.git$/.exec(repo)) === null || _a === void 0 ? void 0 : _a[1]) || '';
+            const base = siteBase || baseFromRepo || '';
             if (!base) {
                 logger.warn(`${logPrefix} Failed to parse base from repo, site base path will not be updated.`);
                 return config;
             }
-            config.base = `/${base}/`;
+            config.base = normalizeBase(base);
             return config;
         },
         async afterBuild(config, isBuild) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rspress-plugin-gh-pages",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Rspress plugin that add support for automatic deployment to GitHub Pages",
   "keywords": [
     "rspress",

package/src/index.ts

@@ -1,5 +1,3 @@
-import path from 'node:path';
-
 import chalk from 'chalk';
 import ghpages from 'gh-pages';
 import { logger } from '@rspress/shared/logger';
@@ -7,8 +5,6 @@ import { logger } from '@rspress/shared/logger';
 import type { MarkRequired } from 'rspress-plugin-devkit';
 import type { RspressPlugin } from '@rspress/shared';
 
-export const componentsPath = path.join(__dirname, './components');
-
 const DefaultDocBuildOutput = 'doc_build';
 
 interface RspressPluginGHPagesOptions
@@ -20,6 +16,12 @@ interface RspressPluginGHPagesOptions
 
 const logPrefix = chalk.green('[gh-pages]');
 
+function normalizeBase(base: string): string {
+  return base === '/' || base === ''
+    ? '/'
+    : `/${base.replace(/^\/+|\/+$/g, '')}/`;
+}
+
 export default function rspressPluginGHPages(
   options: RspressPluginGHPagesOptions,
 ): RspressPlugin {
@@ -35,8 +37,12 @@ export default function rspressPluginGHPages(
   return {
     name: 'rspress-plugin-gh-pages',
     config(config) {
+      let baseFromRepo = repo.includes('github.io')
+        ? '/'
+        : /\/([^\/]+)\.git$/.exec(repo)?.[1];
+
       // Use || here to as ?? will consider '' as a valid value
-      const base = siteBase || /\/([^\/]+)\.git$/.exec(repo)?.[1] || '';
+      const base = siteBase || baseFromRepo || '';
 
       if (!base) {
         logger.warn(
@@ -46,7 +52,7 @@ export default function rspressPluginGHPages(
         return config;
       }
 
-      config.base = `/${base}/`;
+      config.base = normalizeBase(base);
 
       return config;
     },