JekyllAPI

 
public protocol JekyllAPI

Describes the API for Jekyll

  • Undocumented

    Declaration

    Swift

    typealias VerboseOutput = (ast: String, rendered: String)

  • Undocumented

    Declaration

    Swift

    typealias URLVerboseOutput = (url: URL, ast: String, rendered: String)

  • Renders content into jekyll format.

    Declaration

    Swift

    static func renderVerbose(
    content: String,
    permalink: String
) -> EnvIO<ProgressReport, nef.Error, VerboseOutput>

    Parameters

    content

    Content page in Xcode playground.
    permalink

    Relative url where locate the page.

    Return Value

    An EnvIO to perform IO operations that produce errors of type nef.Error and values with the render information, having access to an immutable environment of type ProgressReport.

  • Renders content into jekyll file.

    Declaration

    Swift

    static func renderVerbose(
    content: String,
    permalink: String,
    toFile file: URL
) -> EnvIO<ProgressReport, nef.Error, URLVerboseOutput>

    Parameters

    content

    Content page in Xcode playground.
    permalink

    Relative url where locate the page.
    toFile

    Output where to write the Markdown render.

    Return Value

    An EnvIO to perform IO operations that produce errors of type nef.Error and values with the render information, having access to an immutable environment of type ProgressReport.

  • Renders playground pages into jekyll files.

    Declaration

    Swift

    static func render(
    playground: URL,
    into output: URL
) -> EnvIO<ProgressReport, nef.Error, NEA<URL>>

    Parameters

    playground

    Path to Xcode playground.
    into

    Folder where to render the jekyll files (for each playground’s page).

    Return Value

    An EnvIO to perform IO operations that produce errors of type nef.Error and the jekyll files generated of type [URL], having access to an immutable environment of type ProgressReport.

  • Renders playground pages into jekyll files.

    Declaration

    Swift

    static func render(
    playgroundsAt: URL,
    mainPage: URL,
    into output: URL
) -> EnvIO<ProgressReport, nef.Error, NEA<URL>>

    Parameters

    playgroundsAt

    Folder where to search Xcode Playgrounds (recursive search).
    mainPage

    The main page path (in jekyll file format).
    into

    Folder where to render the jekyll site.

    Return Value

    An EnvIO to perform IO operations that produce errors of type nef.Error and the playgrounds path rendered [URL], having access to an immutable environment of type ProgressReport.

  • Renders content into jekyll format.

    Declaration

    Swift

    static func render(
    content: String,
    permalink: String
) -> EnvIO<ProgressReport, nef.Error, String>

    Parameters

    content

    Content page in Xcode playground.
    permalink

    Relative url where locate the page.

    Return Value

    An EnvIO to perform IO operations that produce errors of type nef.Error and the jekyll generated of type String, having access to an immutable environment of type ProgressReport.

  • render(page:permalink:) Extension method

    Renders content into jekyll format.

    Declaration

    Swift

    static func render(
    page: URL,
    permalink: String
) -> EnvIO<ProgressReport, nef.Error, String>

    Parameters

    page

    Path to Xcode playground page.
    permalink

    Relative url where locate the page.

    Return Value

    An EnvIO to perform IO operations that produce errors of type nef.Error and the jekyll generated of type String, having access to an immutable environment of type ProgressReport.

  • Renders content into jekyll format.

    Declaration

    Swift

    static func renderVerbose(
    page: URL,
    permalink: String
) -> EnvIO<ProgressReport, nef.Error, VerboseOutput>

    Parameters

    page

    Path to Xcode playground page.
    permalink

    Relative url where locate the page.

    Return Value

    An EnvIO to perform IO operations that produce errors of type nef.Error and values with the render information, having access to an immutable environment of type ProgressReport.

  • Renders content into jekyll file.

    Declaration

    Swift

    static func render(
    content: String,
    permalink: String,
    toFile file: URL
) -> EnvIO<ProgressReport, nef.Error, URL>

    Parameters

    content

    Content page in Xcode playground.
    permalink

    Relative url where locate the page.
    toFile

    Output where to write the Markdown render.

    Return Value

    An EnvIO to perform IO operations that produce errors of type nef.Error and the file generated of type URL, having access to an immutable environment of type ProgressReport.

  • Renders content into jekyll file.

    Declaration

    Swift

    static func render(
    page: URL,
    permalink: String,
    toFile file: URL
) -> EnvIO<ProgressReport, nef.Error, URL>

    Parameters

    page

    Path to Xcode playground page.
    permalink

    Relative url where locate the page.
    toFile

    Output where to write the Markdown render.

    Return Value

    An EnvIO to perform IO operations that produce errors of type nef.Error and the file generated of type URL, having access to an immutable environment of type ProgressReport.

  • Renders content into jekyll file.

    Declaration

    Swift

    static func renderVerbose(
    page: URL,
    permalink: String,
    toFile file: URL
) -> EnvIO<ProgressReport, nef.Error, URLVerboseOutput>

    Parameters

    page

    Path to Xcode playground page.
    permalink

    Relative url where locate the page.
    toFile

    Output where to write the Markdown render.

    Return Value

    An EnvIO to perform IO operations that produce errors of type nef.Error and values with the render information, having access to an immutable environment of type ProgressReport.