{"id":22283735,"url":"https://github.com/veaba/vuepress-actions","last_synced_at":"2025-07-28T21:32:59.286Z","repository":{"id":65162204,"uuid":"214934079","full_name":"veaba/vuepress-actions","owner":"veaba","description":"A simple github actions for the Vuepress project build。（一个简单的 Vuepress 项目部署 Github Actions，支持自定义域名）","archived":false,"fork":false,"pushed_at":"2020-12-07T14:49:39.000Z","size":165,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-17T09:02:32.264Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/veaba.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-14T02:50:27.000Z","updated_at":"2021-09-21T07:22:09.000Z","dependencies_parsed_at":"2023-01-05T05:03:15.908Z","dependency_job_id":null,"html_url":"https://github.com/veaba/vuepress-actions","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veaba%2Fvuepress-actions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veaba%2Fvuepress-actions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veaba%2Fvuepress-actions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veaba%2Fvuepress-actions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/veaba","download_url":"https://codeload.github.com/veaba/vuepress-actions/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227960443,"owners_count":17847792,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-03T16:41:56.620Z","updated_at":"2025-07-28T21:32:59.274Z","avatar_url":"https://github.com/veaba.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vuepress\n\n![Vuepress CI](https://github.com/veaba/vuepress-actions/workflows/Vuepress%20CI/badge.svg)\n\n一个简单的 vuepres 项目部署工具，[Marketplace Actions Release Vuepress docs](https://github.com/marketplace/actions/release-vuepress-docs)\n\n```yaml\n- name: Release Vuepress docs\n  uses: veaba/vuepress-actions@v0.83\n```\n\n## Usage\n### Generate deploy token\n\n```shell\n ssh-keygen -t rsa -b 4096 -C \"your@email.com\" -f gh-pages -N '\"\"'\n # gh-pages.pub 公钥\n # gh-pages 私钥\n```\n\n### Setting ssh key \n\n**Deploy key 添加公钥**：\n\n在你的 `Repo` 中，找到 `setting`，在左侧 `Deploy keys` ，起个名字，将 `gh-pages.pub` 复制进去。\n\n**Secrets 添加私钥**：\n\n在你的 `Repo` 中，找到 `setting`，在左侧 `Secrets`，起个名字，如 `ACCESS_TOKEN`，将 `gh-pages` 复制进去。\n\n**记住这个名字：`ACCESS_TOKEN`**，务必与 `env.ACCESS_TOKEN_DEPLOY` 保持一致，见后面给出的范例\n\n### Add Github Action\n\n[范例](https://github.com/veaba/deno-docs/blob/master/.github/workflows/release.yml)：\n\n```yml\nname: release docs CI\n\non: \n  push:\n    branches:\n      - master\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n\n    strategy:\n      matrix:\n        node-version: [12.x]\n\n    steps:\n      - uses: actions/checkout@v1\n      - name: 步骤：第一步 -\u003e Use Node.js ${{ matrix.node-version }}\n        uses: actions/setup-node@v1\n        with:\n          node-version: ${{ matrix.node-version }}\n\n      - name: 步骤：第二步 -\u003e 安装依赖\n        run: |\n          npm install\n          npm run build\n        env:\n          CI: true\n\n      - name: 步骤：第三步 -\u003e 使用脚本部署\n        env:\n          ACCESS_TOKEN_DEPLOY: ${{secrets.ACCESS_TOKEN }}\n          PUBLISH_BRANCH: gh-pages\n          PUBLISH_DIR: ./docs/.vuepress/dist\n          CNAME: deno.datav.ai\n        uses: veaba/vuepress-actions@v0.83 \n```\n\n注意，为了确保获得功能正常，请始终使用最新版：\n\n- `veaba/vuepress-actions@v0.83` 这是一个预生产版本，它已经可以工作了，[参考 deno-docs](https://github.com/veaba/deno-docs/actions/runs/406004283)。\n\n- `CNAME` 部分是用户自己配置的域名。\n\n- 如果一切成功，将会在 Actions 中看到执行结果\n\n- 同时，会在生成一个 `gh-pages` 分支\n\n- 这个脚本是与 `vuepress`项目绑定的，请务必是一个正常的 `vuepress` 项目\n\n\n## Options\n\n- PUBLISH_BRANCH\n- PUBLISH_DIR\n- CNAME\n\n用户见前述\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveaba%2Fvuepress-actions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fveaba%2Fvuepress-actions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveaba%2Fvuepress-actions/lists"}