rspress-plugin-gh-pages 0.1.3 → 0.1.5-beta.0

package/CHANGELOG.md

@@ -0,0 +1,26 @@
+# rspress-plugin-gh-pages
+
+## 0.1.5-beta.0
+
+### Patch Changes
+
+- Updated dependencies [932dbb7]
+  - rspress-plugin-devkit@0.1.2-beta.0
+
+## 0.1.4
+
+### Patch Changes
+
+- 546dcf0: release beta
+- 5e28903: fixup publish config
+- Updated dependencies [546dcf0]
+- Updated dependencies [5e28903]
+  - rspress-plugin-devkit@0.1.1
+
+## 0.1.4-beta.0
+
+### Patch Changes
+
+- 546dcf0: release beta
+- Updated dependencies [546dcf0]
+  - rspress-plugin-devkit@0.1.1-beta.0

package/README.md

@@ -1,5 +1,7 @@
 # rspress-plugin-gh-pages ![NPM Version](https://img.shields.io/npm/v/rspress-plugin-gh-pages)
 
+[简体中文](./README.zh-CN.md)
+
 Rspress plugin to add support for automatic deployment to GitHub Pages.
 
 - **No need to push the code and wait for the pages to be updated**: Every time you run `rspress build`, the plugin will automatically push the generated files to the specified `gh-pages` branch of the repository
@@ -30,12 +32,11 @@ export default defineConfig({
 
 ## Configure
 
-## repo
+## directory
 
-- Type: `string`
-- `Required`
+Target directory to push to the `gh-pages` branch, `config.outDir` will be used if this configuration is not specified.
 
-The repository to deploy to, you can also specify another repository to deploy to.
+- Type: `string`
 
 ## siteBase
 
@@ -43,4 +44,20 @@ The repository to deploy to, you can also specify another repository to deploy t
 
 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.
+By default, this plugin 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.
+
+## silent
+
+Disable terminal log output from this plugin.
+
+- Type: `boolean`
+- Default: false
+
+## repo
+
+- Type: `string`
+- `Required`
+
+The repository to deploy to, you can also specify another repository to deploy to.
+
+More options can be found in documentation of [gh-pages](https://github.com/tschaub/gh-pages).

package/README.zh-CN.md

@@ -0,0 +1,63 @@
+# rspress-plugin-gh-pages ![NPM Version](https://img.shields.io/npm/v/rspress-plugin-gh-pages)
+
+提供 GitHub Pages 自动部署支持的 Rspress 插件。
+
+- **无需推送代码后寂寞等待页面更新**： 每次运行 `rspress build` 时，插件会自动将生成的静态资源推送到指定仓库的指定分支。
+- **无需复杂的持续集成配置**： 插件仅会将静态文件推送到指定的分支，而无需等待云端构建流程，因此页面更新生效速度更快。
+
+## 使用
+
+```bash
+npm i rspress-plugin-gh-pages
+pnpm add rspress-plugin-gh-pages
+```
+
+```ts
+import * as path from 'path';
+import { defineConfig } from 'rspress/config';
+import ghPages from 'rspress-plugin-gh-pages';
+
+export default defineConfig({
+  root: path.join(__dirname, 'docs'),
+  plugins: [
+    ghpages({
+      repo: 'https://github.com/linbudu599/rspress-plugins.git',
+      branch: 'website',
+    }),
+  ],
+});
+```
+
+## 配置
+
+## directory
+
+将要推送到 `gh-pages` 分支的目标目录，如果未指定此配置，则将使用 `config.outDir`。
+
+- Type: `string`
+
+## siteBase
+
+配置站点的基础路径，可以理解为 `publicPath`.
+
+- Type: `string`
+
+当部署到 `<user>/awesome-plugins` 仓库时，需要将 `siteBase` 配置设置为 `/awesome-plugins`，因为页面将托管在 `https://<user>.github.io/awesome-plugins`。
+
+默认情况下，该插件会尝试解析 `repo` 选项以获取 `siteBase` 值（如果 repo 是一个 `github.io` 类型的仓库，则 `siteBase` 将是 `/`，否则，`siteBase` 将是 `/<repo-name>`），你也可以指定 `siteBase` 选项来覆盖默认值。
+
+## silent
+
+禁用此插件的终端日志输出。
+
+- Type: `boolean`
+- Default: false
+
+## repo
+
+- Type: `string`
+- `Required`
+
+将要部署到的仓库，你也可以指定另一个仓库来部署。
+
+更多选项可以在 [gh-pages](https://github.com/tschaub/gh-pages) 找到。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rspress-plugin-gh-pages",
-  "version": "0.1.3",
+  "version": "0.1.5-beta.0",
   "description": "Rspress plugin that add support for automatic deployment to GitHub Pages",
   "keywords": [
     "rspress",
@@ -20,11 +20,14 @@
   "author": "Linbudu <linbudu599@gmail.com> (https://github.com/linbudu599)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
   "dependencies": {
     "@rspress/shared": "^1.17.1",
     "chalk": "^5.3.0",
     "gh-pages": "^6.1.1",
-    "rspress-plugin-devkit": "^0.1.0"
+    "rspress-plugin-devkit": "^0.1.2-beta.0"
   },
   "devDependencies": {
     "@types/gh-pages": "^6.1.0",
@@ -38,7 +41,6 @@
     "build": "tsc --declarationMap false",
     "dev": "tsc -w",
     "docs:build": "rspress build",
-    "docs:dev": "rspress dev",
-    "prepublish": "npm run build"
+    "docs:dev": "rspress dev"
   }
 }

package/tsconfig.json

@@ -1,7 +1,9 @@
 {
   "compilerOptions": {
     "rootDir": "src",
-    "outDir": "dist"
+    "outDir": "dist",
+    "module": "NodeNext",
+    "moduleResolution": "nodenext"
   },
   "include": ["src"],
   "extends": "../../tsconfig.base.json"