https://github.com/umijs/umi-plugin-gh-pages

umi plugin to publish to Github pages.
https://github.com/umijs/umi-plugin-gh-pages

Last synced: 3 months ago
JSON representation

umi plugin to publish to Github pages.

• Host: GitHub
• URL: https://github.com/umijs/umi-plugin-gh-pages
• Owner: umijs
• License: mit
• Created: 2018-10-24T07:08:37.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-04-08T06:12:10.000Z (over 3 years ago)
• Last Synced: 2024-07-28T20:33:05.113Z (3 months ago)
• Language: TypeScript
• Size: 23.4 KB
• Stars: 16
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# umi-plugin-gh-pages

[![NPM version](https://img.shields.io/npm/v/umi-plugin-gh-pages.svg?style=flat)](https://npmjs.org/package/umi-plugin-gh-pages)

[![NPM downloads](http://img.shields.io/npm/dm/umi-plugin-gh-pages.svg?style=flat)](https://npmjs.org/package/umi-plugin-gh-pages)

umi plugin to publish to Github Pages.

## Usage

Configure in `.umirc.js`,

```js

export default {

  ghPages:{

    dir:'dist',

    useCDN: false,

    getCDNUrl:(gitInfo)=>{return 'url'}

    ...gh-pages#PublishOptions

  }

}

```

## ghPages

### dir

exclude `dir` (default umi config `outputPath`), other options please checkout https://github.com/tschaub/gh-pages#options

### useCDN

use CDN in publicPath ,default use [jsdelivr](https://www.jsdelivr.com/) - A free CDN for Open Source.

### getCDNUrl

Custom CDN url.

### Deploy in GitHub pages

config/config.ts

```ts

{

  ghPages: {

    useCDN: true,

  },

}

```

```bash

umi build

```

or

```bash

$GH_PAGES_USE_CDN=true umi build

```

### Deploy in [vercel](https://vercel.com/) （now）

config/config.ts

```ts

{

  ghPages: {

    branch: 'gh-pages',

    silent: true,

    repo: `https://${process.env.GH_TOKEN}@github.com/alitajs/alita-docs.git`,

  },

}

```

set the [environment variables](https://vercel.com/docs/environment-variables) in vercel, with Production.

![image](https://user-images.githubusercontent.com/11746742/110885160-4f264680-8321-11eb-80f7-8cd6275643b8.png)

```

GH_TOKEN=[tokens]( 

https://github.com/settings/tokens)

GH_PAGES_USE_CDN=true

```

run the command

```bash

$ umi build

```

## Examples

* https://github.com/sorrycc/test-gh-pages

* https://sorrycc.github.io/test-gh-pages/

* https://github.com/alitajs/alita-docs

## LICENSE

MIT

## Other

[如何优雅的使用 CDN 优化博客](https://zhuanlan.zhihu.com/p/362871371)