Giter Club home page Giter Club logo

docpad-plugin-repocloner's Introduction

Repository Cloner Plugin for DocPad

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Clone or update repositories into your DocPad website before generation

Usage

Add the following inside your DocPad configuration file, changing the repo values to what you desire:

	plugins:
		repocloner:
			repos: [
				name: 'Some Repository'
				path: 'src/documents/some-repo'
				branch: 'master'
				url: 'https://github.com/some-org/some-repo.git'
			]

This will update the repository on each initial generation.

If you would like to have repocloner update the repository during subsequent generations, you can do this via the DocPad API:

docpadInstance.action('generate', {populate:true, reload:true})
# populate will cause this plugin to fire, as it emits the populateCollections events
# reload will scan the file system for new files

Install

Install this DocPad plugin by entering docpad install repocloner into your terminal.

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under:

docpad-plugin-repocloner's People

Contributors

balupton avatar dependabot[bot] avatar robloach avatar vsopvsop avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docpad-plugin-repocloner's Issues

"Changing" branches actually merges the new branch into the current one

I have a site that uses this plugin and I recently tried to build from an alternate branch of the cloned repo. Everything appeared to work on my laptop, but failed with an error about configuring my git username and password when I tried it on my server.

When I dug in, I noticed that the underlying safeps plugin was actually merging the new branch into the current one. I filed a ticket there: bevry/safeps#7 but I thought it would make sense to have one here as well.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.