Persisting Documentation

Save compiled documentation to disk.

Overview

Once the in-memory documentation model is finalized each of its graph nodes can be converted to a rendering node and persisted on disk or elsewhere via the Codable protocol.

The DocumentationNodeConverter type converts documentation nodes to rendering nodes:

let converter = DocumentationNodeConverter(bundle: myBundle, context: myContext)
let renderNode = converter.convert(documentationNode)

The render nodes can be persisted on disk as JSON files via JSONEncodingRenderNodeWriter:

let writer = JSONEncodingRenderNodeWriter(targetFolder: outputURL, 
    fileManager: FileManager.default)
try writer.write(renderNode)

The precise path inside the output folder where resulting JSON file is saved is automatically determined by the node type (article, symbol reference, etc.).

Topics

Node Persistence

struct DocumentationNodeConverter
A converter from documentation nodes to render nodes.
struct LinkDestinationSummary
A summary of an element that you can link to from outside the documentation bundle.

Render Node Rewriter

protocol RenderNodeTransforming
A type that modifies a render node.
struct RemoveUnusedReferencesTransformation
A transformation that removes unused references from a render node.
struct RenderNodeTransformationComposition
A transformation that applies two transformations, one after the other.
struct RenderNodeTransformationContext
A value that tracks state and state changes while transforming a render node.
class RenderNodeTransformer
An object that modifies a render node by applying transformations to it.