docs: Add rendered DocC docs

Package.resolved

@@ -27,6 +27,24 @@
           "revision": "26cc5e9ae0947092c7139ef7ba612e34646086c7",
           "version": "0.10.1"
         }
+      },
+      {
+        "package": "SwiftDocCPlugin",
+        "repositoryURL": "https://github.com/apple/swift-docc-plugin.git",
+        "state": {
+          "branch": "main",
+          "revision": "859caac534e94ace18b894ccd9ed301ae4aeda84",
+          "version": null
+        }
+      },
+      {
+        "package": "SymbolKit",
+        "repositoryURL": "https://github.com/apple/swift-docc-symbolkit",
+        "state": {
+          "branch": "main",
+          "revision": "0a45209833f4a151212c1aa38e13cfc03b9462e4",
+          "version": null
+        }
       }
     ]
   },

Package.swift

@@ -14,6 +14,7 @@ let package = Package(
   dependencies: [
     .package(url: "https://github.com/loopwerk/PathKit", from: "1.1.0"),
     .package(url: "https://github.com/JohnSundell/Codextended.git", from: "0.1.0"),
+    .package(url: "https://github.com/apple/swift-docc-plugin.git", branch: "main"),
   ],
   targets: [
     .target(

docs/data/documentation/saga.json

@@ -0,0 +1 @@
+{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Saga uses a system of extendible readers, renderers, and writers, supporting things like Atom feeds, paginating, and strongly typed HTML templates."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Saga is quite flexible: for example you can have one set of metadata for the articles on your blog, and another set of metadata for the apps in your portfolio. At the same time it’s quite easy to configure."}]},{"anchor":"Thanks","level":2,"type":"heading","text":"Thanks"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Inspiration for the API of Saga is very much owed to my favorite (but sadly long unmaintained) static site generator: "},{"type":"reference","isActive":true,"identifier":"https:\/\/github.com\/avelino\/liquidluck"},{"type":"text","text":". Its system of multiple readers and writers is really good and I wanted something similar."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Thanks also goes to "},{"type":"reference","isActive":true,"identifier":"https:\/\/github.com\/JohnSundell\/Publish"},{"type":"text","text":", another static site generator written in Swift, for inspiring me towards custom strongly typed metadata. A huge thanks also for its metadata decoder, which was copied over shamelessly."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can read "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.loopwerk.io\/articles\/tag\/saga\/"},{"type":"text","text":" discussing the inspiration behind the API."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/saga"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Saga\/documentation\/Saga","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A static site generator, written in Swift, allowing you to supply your own metadata types for your items."}],"kind":"symbol","metadata":{"roleHeading":"Framework","externalID":"Saga","title":"Saga","symbolKind":"module","role":"collection","modules":[{"name":"Saga"}]},"hierarchy":{"paths":[[]]},"topicSections":[{"title":"Essentials","identifiers":["doc:\/\/Saga\/documentation\/Saga\/Installation","doc:\/\/Saga\/documentation\/Saga\/GettingStarted","doc:\/\/Saga\/documentation\/Saga\/Architecture","doc:\/\/Saga\/documentation\/Saga\/Reader","doc:\/\/Saga\/documentation\/Saga\/Writer"]},{"title":"Classes","identifiers":["doc:\/\/Saga\/documentation\/Saga\/FileContainer","doc:\/\/Saga\/documentation\/Saga\/Item","doc:\/\/Saga\/documentation\/Saga\/MetadataDecoder","doc:\/\/Saga\/documentation\/Saga\/Saga"]},{"title":"Protocols","identifiers":["doc:\/\/Saga\/documentation\/Saga\/AnyItem","doc:\/\/Saga\/documentation\/Saga\/Metadata"]},{"title":"Structures","identifiers":["doc:\/\/Saga\/documentation\/Saga\/EmptyMetadata","doc:\/\/Saga\/documentation\/Saga\/FileIO","doc:\/\/Saga\/documentation\/Saga\/ItemRenderingContext","doc:\/\/Saga\/documentation\/Saga\/ItemsRenderingContext","doc:\/\/Saga\/documentation\/Saga\/Paginator","doc:\/\/Saga\/documentation\/Saga\/PartitionedRenderingContext"]},{"title":"Type Aliases","identifiers":["doc:\/\/Saga\/documentation\/Saga\/ContextKey"]},{"title":"Enumerations","identifiers":["doc:\/\/Saga\/documentation\/Saga\/ItemWriteMode"]}],"references":{"doc://Saga/documentation/Saga/ContextKey":{"role":"symbol","title":"ContextKey","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"ContextKey"}],"abstract":[],"identifier":"doc:\/\/Saga\/documentation\/Saga\/ContextKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ContextKey"}],"url":"\/documentation\/saga\/contextkey"},"doc://Saga/documentation/Saga/FileContainer":{"role":"symbol","title":"FileContainer","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"FileContainer"}],"abstract":[{"type":"text","text":"A wrapper around a "},{"type":"codeVoice","code":"Path"},{"type":"text","text":", used to keep track if got handled by one of the registered processing steps."}],"identifier":"doc:\/\/Saga\/documentation\/Saga\/FileContainer","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"FileContainer"}],"url":"\/documentation\/saga\/filecontainer"},"doc://Saga/documentation/Saga/Metadata":{"role":"symbol","title":"Metadata","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Metadata"}],"abstract":[],"identifier":"doc:\/\/Saga\/documentation\/Saga\/Metadata","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Metadata"}],"url":"\/documentation\/saga\/metadata"},"https://www.loopwerk.io/articles/tag/saga/":{"title":"this series of articles","titleInlineContent":[{"type":"text","text":"this series of articles"}],"type":"link","identifier":"https:\/\/www.loopwerk.io\/articles\/tag\/saga\/","url":"https:\/\/www.loopwerk.io\/articles\/tag\/saga\/"},"https://github.com/avelino/liquidluck":{"title":"liquidluck","titleInlineContent":[{"type":"text","text":"liquidluck"}],"type":"link","identifier":"https:\/\/github.com\/avelino\/liquidluck","url":"https:\/\/github.com\/avelino\/liquidluck"},"doc://Saga/documentation/Saga/AnyItem":{"role":"symbol","title":"AnyItem","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"AnyItem"}],"abstract":[{"type":"text","text":"A type-erased version of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Saga\/documentation\/Saga\/Item"},{"type":"text","text":"."}],"identifier":"doc:\/\/Saga\/documentation\/Saga\/AnyItem","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AnyItem"}],"url":"\/documentation\/saga\/anyitem"},"doc://Saga/documentation/Saga/Item":{"role":"symbol","title":"Item","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Item"}],"abstract":[{"type":"text","text":"A model reprenting an item."}],"identifier":"doc:\/\/Saga\/documentation\/Saga\/Item","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Item"}],"url":"\/documentation\/saga\/item"},"https://github.com/JohnSundell/Publish":{"title":"Publish","titleInlineContent":[{"type":"text","text":"Publish"}],"type":"link","identifier":"https:\/\/github.com\/JohnSundell\/Publish","url":"https:\/\/github.com\/JohnSundell\/Publish"},"doc://Saga/documentation/Saga/ItemRenderingContext":{"role":"symbol","title":"ItemRenderingContext","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ItemRenderingContext"}],"abstract":[],"identifier":"doc:\/\/Saga\/documentation\/Saga\/ItemRenderingContext","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ItemRenderingContext"}],"url":"\/documentation\/saga\/itemrenderingcontext"},"doc://Saga/documentation/Saga/ItemWriteMode":{"role":"symbol","title":"ItemWriteMode","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"ItemWriteMode"}],"abstract":[{"type":"text","text":"A value that represents item writing modes."}],"identifier":"doc:\/\/Saga\/documentation\/Saga\/ItemWriteMode","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ItemWriteMode"}],"url":"\/documentation\/saga\/itemwritemode"},"doc://Saga/documentation/Saga/Installation":{"role":"article","title":"Installation","abstract":[{"type":"text","text":"How to set up your project with the right dependencies."}],"identifier":"doc:\/\/Saga\/documentation\/Saga\/Installation","kind":"article","type":"topic","url":"\/documentation\/saga\/installation"},"doc://Saga/documentation/Saga":{"role":"collection","title":"Saga","abstract":[{"type":"text","text":"A static site generator, written in Swift, allowing you to supply your own metadata types for your items."}],"identifier":"doc:\/\/Saga\/documentation\/Saga","kind":"symbol","type":"topic","url":"\/documentation\/saga"},"doc://Saga/documentation/Saga/Saga":{"role":"symbol","title":"Saga","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Saga"}],"abstract":[{"type":"text","text":"The main Saga class, used to configure and build your website."}],"identifier":"doc:\/\/Saga\/documentation\/Saga\/Saga","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Saga"}],"url":"\/documentation\/saga\/saga"},"doc://Saga/documentation/Saga/Writer":{"role":"symbol","title":"Writer","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Writer"}],"abstract":[{"type":"text","text":"Writers turn an "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Saga\/documentation\/Saga\/Item"},{"type":"text","text":" into a "},{"type":"codeVoice","code":"String"},{"type":"text","text":" using a “renderer”, and write the resulting "},{"type":"codeVoice","code":"String"},{"type":"text","text":" to a file on disk."}],"identifier":"doc:\/\/Saga\/documentation\/Saga\/Writer","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Writer"}],"url":"\/documentation\/saga\/writer"},"doc://Saga/documentation/Saga/Architecture":{"role":"article","title":"Architecture","abstract":[{"type":"text","text":"An overview of how Saga works."}],"identifier":"doc:\/\/Saga\/documentation\/Saga\/Architecture","kind":"article","type":"topic","url":"\/documentation\/saga\/architecture"},"doc://Saga/documentation/Saga/Reader":{"role":"symbol","title":"Reader","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Reader"}],"abstract":[{"type":"text","text":"Readers are responsible for turning text files into "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Saga\/documentation\/Saga\/Item"},{"type":"text","text":" instances."}],"identifier":"doc:\/\/Saga\/documentation\/Saga\/Reader","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Reader"}],"url":"\/documentation\/saga\/reader"},"doc://Saga/documentation/Saga/ItemsRenderingContext":{"role":"symbol","title":"ItemsRenderingContext","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ItemsRenderingContext"}],"abstract":[],"identifier":"doc:\/\/Saga\/documentation\/Saga\/ItemsRenderingContext","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ItemsRenderingContext"}],"url":"\/documentation\/saga\/itemsrenderingcontext"},"doc://Saga/documentation/Saga/PartitionedRenderingContext":{"role":"symbol","title":"PartitionedRenderingContext","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PartitionedRenderingContext"}],"abstract":[],"identifier":"doc:\/\/Saga\/documentation\/Saga\/PartitionedRenderingContext","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PartitionedRenderingContext"}],"url":"\/documentation\/saga\/partitionedrenderingcontext"},"doc://Saga/documentation/Saga/MetadataDecoder":{"role":"symbol","title":"MetadataDecoder","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"MetadataDecoder"}],"abstract":[],"identifier":"doc:\/\/Saga\/documentation\/Saga\/MetadataDecoder","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"MetadataDecoder"}],"url":"\/documentation\/saga\/metadatadecoder"},"doc://Saga/documentation/Saga/GettingStarted":{"role":"article","title":"Getting Started with Saga","abstract":[{"type":"text","text":"An overview of how to configure Saga to render your pages and articles."}],"identifier":"doc:\/\/Saga\/documentation\/Saga\/GettingStarted","kind":"article","type":"topic","url":"\/documentation\/saga\/gettingstarted"},"doc://Saga/documentation/Saga/Paginator":{"role":"symbol","title":"Paginator","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Paginator"}],"abstract":[{"type":"text","text":"A model representing a paginator."}],"identifier":"doc:\/\/Saga\/documentation\/Saga\/Paginator","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Paginator"}],"url":"\/documentation\/saga\/paginator"},"doc://Saga/documentation/Saga/FileIO":{"role":"symbol","title":"FileIO","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"FileIO"}],"abstract":[{"type":"text","text":"A wrapper around file operations used by Saga, to abstract away the PathKit dependency."}],"identifier":"doc:\/\/Saga\/documentation\/Saga\/FileIO","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"FileIO"}],"url":"\/documentation\/saga\/fileio"},"doc://Saga/documentation/Saga/EmptyMetadata":{"role":"symbol","title":"EmptyMetadata","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"EmptyMetadata"}],"abstract":[{"type":"text","text":"A convenience version of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Saga\/documentation\/Saga\/Metadata"},{"type":"text","text":" that’s just empty. This can be used, for example, when you don’t have custom item metadata or site metadata."}],"identifier":"doc:\/\/Saga\/documentation\/Saga\/EmptyMetadata","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"EmptyMetadata"}],"url":"\/documentation\/saga\/emptymetadata"}}}