MarkdownAPI

 
public protocol MarkdownAPI

Describes the API for Markdown

  • Undocumented

    Declaration

    Swift

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

  • Undocumented

    Declaration

    Swift

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

  • Renders content into markdown.

    Declaration

    Swift

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

    Parameters

    content

    Content page in Xcode playground.

    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 markdown file.

    Declaration

    Swift

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

    Parameters

    content

    Content page in Xcode playground.
    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 markdown 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 write the markdown files.

    Return Value

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

  • Renders playground pages into markdown files.

    Declaration

    Swift

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

    Parameters

    playgroundsAt

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

    Folder where to write the markdown files for each Xcode Playground page.

    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.

  • render(content:) Extension method

    Renders content into markdown.

    Declaration

    Swift

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

    Parameters

    content

    Content page in Xcode playground.

    Return Value

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

  • render(page:) Extension method

    Renders content into markdown.

    Declaration

    Swift

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

    Parameters

    page

    Path to Xcode playground page.

    Return Value

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

  • renderVerbose(page:) Extension method

    Renders content into markdown.

    Declaration

    Swift

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

    Parameters

    page

    Path to Xcode playground 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.

  • render(content:toFile:) Extension method

    Renders content into markdown file.

    Declaration

    Swift

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

    Parameters

    content

    Content page in Xcode playground.
    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.

  • render(page:toFile:) Extension method

    Renders content into markdown file.

    Declaration

    Swift

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

    Parameters

    page

    Path to Xcode playground 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 markdown file.

    Declaration

    Swift

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

    Parameters

    page

    Path to Xcode playground 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.