polly

package module
v0.1.0-alpha.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 27, 2020 License: Apache-2.0 Imports: 3 Imported by: 0

README

Polly

Polly is a preprocessor for Hugo

CircleCI Go Report Card

Table of Contents
  1. Polly is a preprocessor for Hugo
  2. Introduction
  3. Installation
    1. Download (Binary Install)
    2. Build and Install from Source
  4. Usage
  5. Roadmap
  6. Contributing
  7. License
  8. Contact

Introduction

Installation

Download (Binary Install)

Build and Install from Source

Prerequisites
Fetch from GitHub
mkdir $HOME/src
cd $HOME/src
git clone https://github.com/stevexnicholls/polly.git
cd polly
go install

If you are a Windows user, substitute the $HOME environment variable above with %USERPROFILE%.

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the Apache License 2.0. See LICENSE for more information.

Contact

Project Link: https://github.com/stevexnicholls/polly

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterPlugin

func RegisterPlugin(instance Plugin)

RegisterPlugin _

Types

type Config

type Config struct {
	PollyDir   string `json:"pollyDir"`
	ContentDir string `json:"contentDir"`
	LayoutsDir string `json: "layoutsDir"`
}

Config _

type Plugin

type Plugin interface {
	PollyPlugin() PluginInfo
	Provision(context.Context, Config) error
	Execute(context.Context, Config) error
}

Plugin _

func GetPlugin

func GetPlugin(id string) (Plugin, error)

GetPlugin _

func GetPlugins

func GetPlugins() ([]Plugin, error)

GetPlugins _

type PluginInfo

type PluginInfo struct {
	ID  string
	New func() Plugin
}

PluginInfo _

Directories

Path Synopsis
plugins

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL