All Projects → shinnn → Gulp Gh Pages

shinnn / Gulp Gh Pages

Licence: other
A gulp 4 plugin to publish contents to Github pages

Programming Languages

javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to Gulp Gh Pages

GitHub-Education-Portfolio
A portfolio made using React and tools from GitHub Student Developer Pack
Stars: ✭ 50 (-91.82%)
Mutual labels:  github-pages, deployment
Devtron
Software Delivery Workflow For Kubernetes
Stars: ✭ 130 (-78.72%)
Mutual labels:  deployment, release-automation
Git Directory Deploy
deploy a directory as a git branch
Stars: ✭ 526 (-13.91%)
Mutual labels:  github-pages, deployment
Github Pages Deploy Action
Automatically deploy your project to GitHub Pages using GitHub Actions. This action can be configured to push your production-ready code into any branch you'd like.
Stars: ✭ 2,507 (+310.31%)
Mutual labels:  github-pages, deployment
Ghpages
Deploy arbitrary static assets through GitHub Actions
Stars: ✭ 169 (-72.34%)
Mutual labels:  github-pages, deployment
Ghaction Github Pages
GitHub Action to deploy to GitHub Pages
Stars: ✭ 153 (-74.96%)
Mutual labels:  github-pages, deployment
Jekyll Github Deploy
Jekyll Site Automated Deployer to GitHub Pages
Stars: ✭ 67 (-89.03%)
Mutual labels:  github-pages, deployment
actions-publish-gh-pages
🍣 A GitHub Action to publish static website using GitHub Pages
Stars: ✭ 12 (-98.04%)
Mutual labels:  github-pages, deployment
gulp-yaml
A Gulp plugin to convert YAML to JSON
Stars: ✭ 24 (-96.07%)
Mutual labels:  gulp-plugin, stream
Gulp Angular Templatecache
Concatenates and registers AngularJS templates in the $templateCache.
Stars: ✭ 530 (-13.26%)
Mutual labels:  gulp-plugin
Athena
an open-source implementation of sequence-to-sequence based speech processing engine
Stars: ✭ 542 (-11.29%)
Mutual labels:  deployment
Gradle Tomcat Plugin
Gradle plugin supporting deployment of your web application to an embedded Tomcat web container
Stars: ✭ 516 (-15.55%)
Mutual labels:  deployment
Mediathekviewweb
Eine Weboberfläche als Alternative zum Java-Client
Stars: ✭ 543 (-11.13%)
Mutual labels:  stream
Jekyll Theme Basically Basic
Your new Jekyll default theme
Stars: ✭ 524 (-14.24%)
Mutual labels:  github-pages
Lol Html
Low output latency streaming HTML parser/rewriter with CSS selector-based API
Stars: ✭ 566 (-7.36%)
Mutual labels:  stream
Gulp Pug
Gulp plugin for compiling Pug templates
Stars: ✭ 512 (-16.2%)
Mutual labels:  gulp-plugin
Nginx Rtmp Docker
Docker image with Nginx using the nginx-rtmp-module module for live multimedia (video) streaming.
Stars: ✭ 506 (-17.18%)
Mutual labels:  stream
Shipit
Universal automation and deployment tool ⛵️
Stars: ✭ 5,249 (+759.08%)
Mutual labels:  deployment
Jekyll Uno
Jekyll-Uno - a minimal, responsive theme for Jekyll based on Uno for Ghost
Stars: ✭ 559 (-8.51%)
Mutual labels:  github-pages
Cubit
Cubit is a lightweight state management solution. It is a subset of the bloc package that does not rely on events and instead uses methods to emit new states.
Stars: ✭ 539 (-11.78%)
Mutual labels:  stream

gulp-gh-pages

npm version Build Status Build status Coverage Status

gulp plugin to publish contents to Github pages

Installation

Use npm.

npm install --save-dev [email protected] gulp-gh-pages

Usage

Define a deploy task in your gulpfile.js (as below) which can be used to push to gh-pages going forward.

const {src, task}= require('gulp');
const ghPages = require('gulp-gh-pages');

task('deploy', () => src('./dist/**/*').pipe(ghPages()));

Now, you should be able to call your task by doing:

gulp deploy

API

const ghPages = require('gulp-gh-pages');

ghPages([options])

options: Object
Return: stream.Transform

options.remoteUrl

Type: string
Default: URL for the remote of the current dir (assumes a git repository)

By default gulp-gh-pages assumes the current working directory is a git repository and uses the URL of the remote designated by origin. If your gulpfile.js is not in a git repository, or if you want to push to a different remote url, you can specify it. Ensure you have write access to the repository.

options.branch

Type: string
Default: "gh-pages"

The branch where deploy will by done. Change to "master" for username.github.io projects.

options.cacheDir

Type: string
Default: .publish

Set the directory path to keep a cache of the repository. If it doesn't exist, gulp-gh-pages automatically create it.

options.push

Type: boolean
Default: true

Allow you to make a build on the defined branch without pushing it to master. Useful for dry run.

options.force

Type: boolean
Default: false

Force adding files to the gh-pages branch, even if they are ignored by .gitignore or .gitignore_global.

options.message

Type: string
Default: "Update [timestamp]"

Edit commit message.

License

MIT License © 2014 Micheal Benedict, 2015 - 2018 Shinnosuke Watanabe

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].