Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 1.37 KB

README.md

File metadata and controls

48 lines (38 loc) · 1.37 KB

Splash plugin for Publish

A Publish plugin that makes it easy to integrate the Splash Swift syntax highlighter into any Publish website.

Installation

To install it into your Publish package, add it as a dependency within your Package.swift manifest:

let package = Package(
    ...
    dependencies: [
        ...
        .package(name: "SplashPublishPlugin", url: "https://github.com/johnsundell/splashpublishplugin", from: "0.1.0")
    ],
    targets: [
        .target(
            ...
            dependencies: [
                ...
                "SplashPublishPlugin"
            ]
        )
    ]
    ...
)

Then import SplashPublishPlugin wherever you’d like to use it:

import SplashPublishPlugin

For more information on how to use the Swift Package Manager, check out this article, or its official documentation.

Usage

The plugin can then be used within any publishing pipeline like this:

import SplashPublishPlugin
...
try DeliciousRecipes().publish(using: [
    .installPlugin(.splash(withClassPrefix: "classPrefix"))
    ...
])