Swiftpack.co - Package - john-mueller/TidyHTMLPublishStep

Tidy HTML step for Publish

A PublishingStep for Publish that nicely formats your website's HTML using SwiftSoup.

Installation

To install the step, add it as a dependency within your Package.swift manifest:

let package = Package(
    ...
    dependencies: [
        ...
        .package(url: "https://github.com/john-mueller/TidyHTMLPublishStep", from: "0.1.0")
    ],
    targets: [
        .target(
            ...
            dependencies: [
                ...
                "TidyHTMLPublishStep"
            ]
        )
    ]
    ...
)

Then import TidyHTMLPublishStep where you'd like to use it.

Usage

The tidyHTML(withIndentation:) step should be inserted into your publishing pipeline after your HTML is generated. The default indentation is one space, if the parameter is omitted.

import TidyHTMLPublishStep
...
try DeliciousRecipes().publish(using: [
    ...
    .generateHTML(withTheme: .foundation),
    ...
    .tidyHTML(indentedBy: .spaces(4))
    ...
])

This package also provides an alternate convenience API to the Website.publish(withTheme:...:additionalSteps:...) method, replacing additionalSteps with preGenerationSteps and postGenerationSteps. The tidyHTML step should be passed to the postGenerationSteps parameter:

import TidyHTMLPublishStep
...
try DeliciousRecipes().publish(
    withTheme: theme,
    postGenerationSteps: [
        .tidyHTML()
    ]
)

Github

link
Stars: 0

Used By

Total: 0

Releases

Version 0.1.1 - 2020-02-14 21:06:15

Added documentation comments

Version 0.1.0 - 2020-02-10 21:42:15

Initial release of the Tidy HTML Publish step