https://github.com/strugee/gh-pages-bootstrap

Tool to aid migration away from GitHub Pages by automatically recreating GitHub's directory structure
https://github.com/strugee/gh-pages-bootstrap

hacktoberfest javascript nodejs

Last synced: about 1 year ago
JSON representation

Tool to aid migration away from GitHub Pages by automatically recreating GitHub's directory structure

• Host: GitHub
• URL: https://github.com/strugee/gh-pages-bootstrap
• Owner: strugee
• License: gpl-3.0
• Created: 2015-06-12T10:41:54.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-09-06T07:06:29.000Z (almost 2 years ago)
• Last Synced: 2025-04-14T05:56:09.539Z (about 1 year ago)
• Topics: hacktoberfest, javascript, nodejs
• Language: JavaScript
• Homepage:
• Size: 56.6 KB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# gh-pages-bootstrap

[![NPM](https://nodei.co/npm/gh-pages-bootstrap.png)](https://npmjs.org/package/gh-pages-bootstrap)

## About

### The problem

Your website is currently hosted on GitHub Pages, but you're moving away. Maybe you want to deploy TLS (good on you!), or maybe GitHub's URL construction is too inflexible for you.

However, when you move your site to a different server, suddenly all your links break. You find yourself manually `git clone`ing all of your repositories just to get a usable website!

### The solution

`gh-pages-bootstrap` is a small utility to automate this for you. It queries the GitHub API and then reconstructs exactly what you'd see on GitHub Pages on your local disk. Presto!

## Installation

    npm install gh-pages-bootstrap

Or as a CLI tool:

    npm install -g gh-pages-bootstrap

## Usage

As a module:

``` js

var bootstrap = require('gh-pages-bootstrap');

var user = 'someone'; // GitHub user

var token = 'a1b2c3d4e5f6g7h8i9j0'; // GitHub OAuth2 token

ghpages(user, token, function(err) {

	throw err;

});

```

On the commandline:

    $ gh-pages-bootstrap

This will prompt you for your GitHub username and password. If you run it a second time, it will use the cached OAuth2 token.

## Author

AJ Jordan (@strugee on GitHub)

## License

LGPL3+