https://github.com/rohmanhm/gh-to-pages

💫 Convert Github Repo URL to Github Pages
https://github.com/rohmanhm/gh-to-pages

convert gh-to-pages git github-pages

Last synced: 2 months ago
JSON representation

💫 Convert Github Repo URL to Github Pages

• Host: GitHub
• URL: https://github.com/rohmanhm/gh-to-pages
• Owner: rohmanhm
• License: mit
• Created: 2017-05-24T13:52:30.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2019-09-16T07:22:28.000Z (almost 7 years ago)
• Last Synced: 2025-04-11T23:48:43.163Z (about 1 year ago)
• Topics: convert, gh-to-pages, git, github-pages
• Language: JavaScript
• Homepage:
• Size: 242 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 💫 GH-TO-PAGES

[![Greenkeeper badge](https://badges.greenkeeper.io/rohmanhm/gh-to-pages.svg)](https://greenkeeper.io/)

[![Build Status](https://travis-ci.org/rohmanhm/gh-to-pages.svg?branch=master)](https://travis-ci.org/rohmanhm/gh-to-pages)

> Convert Github Repo URL to Github Pages

## Example

Convert from

```javascript

'https://github.com/rohmanhm/gh-to-pages' // support with https protocol

'http://github.com/rohmanhm/gh-to-pages' // support with http protocol

'github.com/rohmanhm/gh-to-pages' // support without protocol

'git@github.com:rohmanhm/gh-to-pages.git' // support ssh url

```

to

```javascript

'https://rohmanhm.github.io/gh-to-pages'

```

## Install

  * NPM

    ```bash

    npm install gh-to-pages --save

    ```

  * Yarn

    ```bash

    yarn add gh-to-pages

    ```

## How to use

```javascript

// es6

import ghToPages from 'gh-to-pages'

// commonjs

const ghToPages = require('gh-to-pages')

ghToPages('https://github.com/rohmanhm/gh-to-pages') // result https://rohmanhm.github.io/gh-to-pages

```

## LICENSE

MIT @rohmanhm