gatsby-plugin-github-pages
Advanced tools
gatsby-plugin-github-pages - npm Package Compare versions
Comparing version 0.0.0 to 0.1.0
| { | ||
| "name": "gatsby-plugin-github-pages", | ||
| "version": "0.0.0", | ||
| "version": "0.1.0", | ||
| "description": "Gatsby plugin that deploys to Github Pages post-build.", | ||
@@ -15,2 +15,3 @@ "main": "index.js", | ||
| "bluebird": "^3.5.1", | ||
| "gatsby-cli": "^1.1.23", | ||
| "gh-pages": "^1.1.0" | ||
@@ -30,3 +31,8 @@ }, | ||
| "lint" | ||
| ] | ||
| ], | ||
| "standard": { | ||
| "ignore": [ | ||
| "/example" | ||
| ] | ||
| } | ||
| } |
| # Gatsby Plugin GitHub Pages | ||
| A Gatsby plugin that deploys your build to Github Pages. | ||
| A Gatsby plugin that deploys your public folder to Github Pages on build. | ||
| With no configuration the destination is root to a `gh-pages` branch on the current repository. | ||
| The branch, directory, and repository my all be changed via the `publishOptions` config. | ||
| The Gatsby site in the example directory is hosted at [https://rongierlach.github.io/gatsby-plugin-github-pages](https://rongierlach.github.io/gatsby-plugin-github-pages). | ||
| ## Install | ||
@@ -8,17 +14,16 @@ `$ npm install gatsby-plugin-github-pages` | ||
| ## Usage | ||
| In your `gatsby-config.js` file: | ||
| Place the plugin *last* in your plugins array. | ||
| #### **[User and Organization Pages](https://help.github.com/articles/user-organization-and-project-pages/#project-pages)** | ||
| If you are using a custom domain for your page you must specify it in the `gatsby-config.js` file like so: | ||
| ```javascript | ||
| module.exports = { | ||
| plugins: [ | ||
| /* ... */ | ||
| /* other plugins */ | ||
| { | ||
| resolve: 'gatsby-plugin-github-pages' | ||
| options: { | ||
| customDomain: 'mycustomdomain.com', // optional | ||
| publishOptions: { // defaults | ||
| src: '**/*', | ||
| branch: 'gh-pages', | ||
| dest: '.', | ||
| repo: 'https://example.com/other/repo.git' | ||
| // ... | ||
| customDomain: 'mycustomdomain.com' | ||
| publishOptions: { | ||
| /* ... */ | ||
| } | ||
@@ -31,3 +36,25 @@ } | ||
| #### **[Project Pages](https://help.github.com/articles/user-organization-and-project-pages/#project-pages)** | ||
| You must build with the prefix-paths flag like so: | ||
| `$ gatsby build --prefix-paths` | ||
| You must also specify a [`pathPrefix`](https://www.gatsbyjs.org/docs/path-prefix/) in your `gatsby-config.js` file: | ||
| ```javascript | ||
| module.exports = { | ||
| pathPrefix: '/name-of-your-repo', | ||
| plugins: [ | ||
| /* other plugins */ | ||
| { | ||
| resolve: 'gatsby-plugin-github-pages' | ||
| options: { | ||
| publishOptions: { | ||
| /* ... */ | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
| ## Publish Options | ||
| The plugin uses `gh-pages` internally, publish options can be found in greater detail [here](https://github.com/tschaub/gh-pages#options). |
Improved metrics
- Total package byte prevSize
- increased by17.99%
7437
- Number of lines in readme file
- increased by84.38%
59
Worsened metrics
- Dependency count
- increased by50%
3
Dependency changes
+ Addedgatsby-cli@^1.1.23
+ Addedansi-align@2.0.0(transitive)
+ Addedansi-escapes@3.2.0(transitive)
+ Addedansi-regex@2.1.13.0.1(transitive)
+ Addedansi-styles@2.2.13.2.1(transitive)
+ Addedarray-find-index@1.0.2(transitive)
+ Addedbabel-code-frame@6.26.0(transitive)
+ Addedbabel-runtime@6.26.0(transitive)
+ Addedboolbase@1.0.0(transitive)
+ Addedboxen@1.3.0(transitive)
+ Addedbuiltin-modules@1.1.1(transitive)
+ Addedcamelcase@4.1.0(transitive)
+ Addedcapture-stack-trace@1.0.2(transitive)
+ Addedchalk@1.1.32.4.2(transitive)
+ Addedchardet@0.4.2(transitive)
+ Addedci-info@1.6.0(transitive)
+ Addedcli-boxes@1.0.0(transitive)
+ Addedcli-cursor@2.1.0(transitive)
+ Addedcli-width@2.2.1(transitive)
+ Addedcliui@4.1.0(transitive)
+ Addedcode-point-at@1.1.0(transitive)
+ Addedcolor-convert@1.9.3(transitive)
+ Addedcolor-name@1.1.3(transitive)
+ Addedcommon-tags@1.8.2(transitive)
+ Addedconfigstore@3.1.5(transitive)
+ Addedconvert-hrtime@2.0.0(transitive)
+ Addedcore-js@2.6.12(transitive)
+ Addedcreate-error-class@3.0.2(transitive)
+ Addedcross-spawn@5.1.06.0.6(transitive)
+ Addedcrypto-random-string@1.0.0(transitive)
+ Addedcss-select@4.3.0(transitive)
+ Addedcss-what@6.1.0(transitive)
+ Addedcurrently-unhandled@0.4.1(transitive)
+ Addeddeath@1.1.0(transitive)
+ Addeddebug@2.6.9(transitive)
+ Addeddecamelize@1.2.0(transitive)
+ Addeddeep-extend@0.6.0(transitive)
+ Addeddetect-indent@5.0.0(transitive)
+ Addeddom-converter@0.2.0(transitive)
+ Addeddom-serializer@1.4.1(transitive)
+ Addeddomelementtype@2.3.0(transitive)
+ Addeddomhandler@4.3.1(transitive)
+ Addeddomutils@2.8.0(transitive)
+ Addeddot-prop@4.2.1(transitive)
+ Addedduplexer3@0.1.5(transitive)
+ Addedend-of-stream@1.4.4(transitive)
+ Addedentities@2.2.0(transitive)
+ Addedenvinfo@5.12.1(transitive)
+ Addedesutils@2.0.3(transitive)
+ Addedexeca@0.7.00.8.01.0.0(transitive)
+ Addedexternal-editor@2.2.0(transitive)
+ Addedfigures@2.0.0(transitive)
+ Addedfind-up@2.1.0(transitive)
+ Addedfs-extra@4.0.3(transitive)
+ Addedgatsby-cli@1.1.58(transitive)
+ Addedget-caller-file@1.0.3(transitive)
+ Addedget-stream@3.0.04.1.0(transitive)
+ Addedglobal-dirs@0.1.1(transitive)
+ Addedgot@6.7.1(transitive)
+ Addedgraceful-fs@4.2.11(transitive)
+ Addedhas-ansi@2.0.0(transitive)
+ Addedhas-flag@3.0.0(transitive)
+ Addedhosted-git-info@2.8.9(transitive)
+ Addedhtmlparser2@6.1.0(transitive)
+ Addediconv-lite@0.4.24(transitive)
+ Addedimport-lazy@2.1.0(transitive)
+ Addedimurmurhash@0.1.4(transitive)
+ Addedini@1.3.8(transitive)
+ Addedinquirer@3.3.0(transitive)
+ Addedinvariant@2.2.4(transitive)
+ Addedinvert-kv@2.0.0(transitive)
+ Addedis-builtin-module@1.0.0(transitive)
+ Addedis-ci@1.2.1(transitive)
+ Addedis-fullwidth-code-point@1.0.02.0.0(transitive)
+ Addedis-installed-globally@0.1.0(transitive)
+ Addedis-npm@1.0.0(transitive)
+ Addedis-obj@1.0.1(transitive)
+ Addedis-path-inside@1.0.1(transitive)
+ Addedis-redirect@1.0.0(transitive)
+ Addedis-retry-allowed@1.2.0(transitive)
+ Addedis-stream@1.1.0(transitive)
+ Addedisexe@2.0.0(transitive)
+ Addedjs-tokens@3.0.2(transitive)
+ Addedlatest-version@3.1.0(transitive)
+ Addedlcid@2.0.0(transitive)
+ Addedleven@2.1.0(transitive)
+ Addedlocate-path@2.0.0(transitive)
+ Addedloose-envify@1.4.0(transitive)
+ Addedloud-rejection@1.6.0(transitive)
+ Addedlowercase-keys@1.0.1(transitive)
+ Addedlru-cache@4.1.5(transitive)
+ Addedmake-dir@1.3.0(transitive)
+ Addedmap-age-cleaner@0.1.3(transitive)
+ Addedmem@4.3.0(transitive)
+ Addedmimic-fn@1.2.02.1.0(transitive)
+ Addedminimist@1.2.8(transitive)
+ Addedms@2.0.0(transitive)
+ Addedmute-stream@0.0.7(transitive)
+ Addednice-try@1.0.5(transitive)
+ Addednode-emoji@1.11.0(transitive)
+ Addednpm-run-path@2.0.2(transitive)
+ Addednth-check@2.1.1(transitive)
+ Addednumber-is-nan@1.0.1(transitive)
+ Addedobject-path@0.11.8(transitive)
+ Addedonetime@2.0.1(transitive)
+ Addedos-locale@3.1.0(transitive)
+ Addedos-tmpdir@1.0.2(transitive)
+ Addedp-defer@1.0.0(transitive)
+ Addedp-finally@1.0.0(transitive)
+ Addedp-is-promise@2.1.0(transitive)
+ Addedp-limit@1.3.0(transitive)
+ Addedp-locate@2.0.0(transitive)
+ Addedp-try@1.0.0(transitive)
+ Addedpackage-json@4.0.1(transitive)
+ Addedpath-exists@3.0.0(transitive)
+ Addedpath-is-inside@1.0.2(transitive)
+ Addedpath-key@2.0.1(transitive)
+ Addedpify@3.0.0(transitive)
+ Addedpretty-error@2.1.2(transitive)
+ Addedpseudomap@1.0.2(transitive)
+ Addedpump@3.0.2(transitive)
+ Addedrc@1.2.8(transitive)
+ Addedread@1.0.7(transitive)
+ Addedregenerator-runtime@0.11.1(transitive)
+ Addedregistry-auth-token@3.4.0(transitive)
+ Addedregistry-url@3.1.0(transitive)
+ Addedrenderkid@2.0.7(transitive)
+ Addedrequire-directory@2.1.1(transitive)
+ Addedrequire-main-filename@1.0.1(transitive)
+ Addedresolve-cwd@2.0.0(transitive)
+ Addedresolve-from@3.0.0(transitive)
+ Addedrestore-cursor@2.0.0(transitive)
+ Addedrun-async@2.4.1(transitive)
+ Addedrx-lite@4.0.8(transitive)
+ Addedrx-lite-aggregates@4.0.8(transitive)
+ Addedsafe-buffer@5.2.1(transitive)
+ Addedsafer-buffer@2.1.2(transitive)
+ Addedsemver@5.7.2(transitive)
+ Addedsemver-diff@2.1.0(transitive)
+ Addedset-blocking@2.0.0(transitive)
+ Addedshebang-command@1.2.0(transitive)
+ Addedshebang-regex@1.0.0(transitive)
+ Addedsignal-exit@3.0.7(transitive)
+ Addedsource-map@0.5.7(transitive)
+ Addedstack-trace@0.0.10(transitive)
+ Addedstring-width@1.0.22.1.1(transitive)
+ Addedstrip-ansi@3.0.14.0.0(transitive)
+ Addedstrip-bom@3.0.0(transitive)
+ Addedstrip-eof@1.0.0(transitive)
+ Addedstrip-json-comments@2.0.1(transitive)
+ Addedsupports-color@2.0.05.5.0(transitive)
+ Addedterm-size@1.2.0(transitive)
+ Addedthrough@2.3.8(transitive)
+ Addedtimed-out@4.0.1(transitive)
+ Addedtmp@0.0.33(transitive)
+ Addedunique-string@1.0.0(transitive)
+ Addedunzip-response@2.0.1(transitive)
+ Addedupdate-notifier@2.5.0(transitive)
+ Addedurl-parse-lax@1.0.0(transitive)
+ Addedutila@0.4.0(transitive)
+ Addedwhich@1.3.1(transitive)
+ Addedwhich-module@2.0.1(transitive)
+ Addedwidest-line@2.0.1(transitive)
+ Addedwrap-ansi@2.1.0(transitive)
+ Addedwrite-file-atomic@2.4.3(transitive)
+ Addedxdg-basedir@3.0.0(transitive)
+ Addedy18n@3.2.2(transitive)
+ Addedyallist@2.1.2(transitive)
+ Addedyargs@11.1.1(transitive)
+ Addedyargs-parser@9.0.2(transitive)
+ Addedyurnalist@0.2.1(transitive)