# publish-github-pages

> Build & publish your docs to github pages

Latest version **0.1.2** (published 2017-11-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install publish-github-pages
pnpm add publish-github-pages
yarn add publish-github-pages
bun add publish-github-pages
```

Provides the command `gh-pages`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2017-11-30 |
| First published | 2017-11-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | torbenm |
| Maintainers | torben.meyer |
| Keywords | git, github, gh-pages, publish, build, tool |

## Links

- npm: https://www.npmjs.com/package/publish-github-pages
- Repository: https://github.com/torbenm/publish-github-pages
- Homepage: https://github.com/torbenm/publish-github-pages#readme
- Issues: https://github.com/torbenm/publish-github-pages/issues
- npm.io page: https://npm.io/package/publish-github-pages

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^2.3.0
- [figures](https://npm.io/package/figures.md) ^2.0.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.7.8

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2017-11-30
- 0.1.1 — 2017-11-30
- 0.1.0 — 2017-11-30

## README

# publish-github-pages

Small tool to make publishing to gh-pages easier.

## Installation

```
npm i -g publish-github-pages
```

## Configuration

Create a file `.gh-pages.json` in the root folder.
It should have the following structure: 

```javascript
{
    "dir": "./path/to/docs",
    "remote": "git@github.com:torbenm/publish-github-pages.git",
    "branch": "gh-pages",
    // any script for creating the docs here
    "build": "touch ${path}/index.html", 
    // ${tags-verbose} will take the value of git describe origin/master --tags
    "commit": "Documentation update ${tags-verbose}" 
}
```

## Running it

Please make sure you have the correct branch in your github repository before.
This is currently mandatory, but will likely change in the future.

```
gh-pages publish
```

---
_Source: https://npm.io/package/publish-github-pages · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._