C
E
M
P
r
P
S
T
docc-static
Essentials
Getting Started with docc-static
Using docc-static Locally
Deployment
Deploying Documentation to Servers
CI/CD Integration
Static Documentation Plugin
Essentials
Getting Started with the Plugin
Plugin Options
Integration
Xcode Integration
DocCStaticThemes
Classes
CollectingWarningHandler
Initializers
init()
Instance Properties
var warnings: [String]
Instance Methods
func handleWarning(String)
Protocols
ThemeParsingWarningHandler
Instance Methods
func handleWarning(String)
Structures
DynamicCodingKey
Initializers
init?(intValue: Int)
init?(stringValue: String)
Instance Properties
var intValue: Int?
var stringValue: String
Default Implementations
CodingKey Implementations
Instance Properties
var debugDescription: String
var description: String
StderrWarningHandler
Initializers
init()
Instance Methods
func handleWarning(String)
ThemeBundleSource
Initializers
init(name: String, settings: ThemeSettingsInput, stylesheets: [ThemeStylesheet])
Instance Properties
var name: String
var settings: ThemeSettingsInput
var stylesheets: [ThemeStylesheet]
Type Methods
static func isBundle(URL) -> Bool
static func load(from: URL, warningHandler: (any ThemeParsingWarningHandler)?) throws -> ThemeBundleSource
static func loadAll(in: URL, warningHandler: (any ThemeParsingWarningHandler)?) throws -> [ThemeBundleSource]
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
ThemeCodeGenerator
Initializers
init(indentation: String)
Instance Properties
let indentation: String
Instance Methods
func generateBadgeDictionary([String : String], baseIndent: Int) -> String
func generateBuiltInThemeEnum(names: [String]) -> String
func generateColourDictionary([String : ColorValueInput], baseIndent: Int) -> String
func generateColourValue(ColorValueInput) -> String
func generateFile(bundles: [ThemeBundleSource], baseStylesheets: [ThemeStylesheet]) -> String
func generateFile(themes: [(name: String, settings: ThemeSettingsInput)]) -> String
func generateHeader() -> String
func generateSpacingDictionary([String : String], baseIndent: Int) -> String
func generateStylesheetArray([ThemeStylesheet], baseIndent: Int) -> String
func generateStylesheetProperty([ThemeStylesheet], propertyName: String) -> String
func generateThemeProperty(settings: ThemeSettingsInput, propertyName: String) -> String
func generateTypographyDictionary([String : String], baseIndent: Int) -> String
func generateValue(ThemeSettingValue, baseIndent: Int) -> String
func generateValueDictionary([String : ThemeSettingValue], baseIndent: Int) -> String
func humanReadableName(from: String) -> String
func rawStringLiteral(String) -> String
func stylesheetPropertyName(for: String) -> String
func swiftCaseName(for: String) -> String
func swiftPropertyName(for: String) -> String
func swiftStringLiteral(String) -> String
ThemeFeatureFlag
Initializers
init(path: [String], defaultValue: Bool, isHonoured: Bool)
Instance Properties
let defaultValue: Bool
var description: String
let isHonoured: Bool
let path: [String]
Type Properties
static let all: [ThemeFeatureFlag]
static let internationalisationEnabled: ThemeFeatureFlag
static let onThisPageNavigatorDisabled: ThemeFeatureFlag
static let quickNavigationEnabled: ThemeFeatureFlag
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
ThemeInput
Initializers
init(badge: [String : String]?, color: [String : ColorValueInput]?, typography: [String : String]?, spacing: [String : String]?, other: [String : ThemeSettingValue]?)
init(from: Decoder) throws
Instance Properties
var badge: [String : String]?
var color: [String : ColorValueInput]?
var other: [String : ThemeSettingValue]?
var spacing: [String : String]?
var typography: [String : String]?
Instance Methods
func encode(to: Encoder) throws
Type Properties
static let genericSectionKeys: Set<String>
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
ThemeSettingsInput
Initializers
init(from: Decoder) throws
init(theme: ThemeInput, meta: [String : AnyCodable]?, features: [String : ThemeSettingValue]?)
Instance Properties
var features: [String : ThemeSettingValue]?
var meta: [String : AnyCodable]?
var theme: ThemeInput
Instance Methods
func isEnabled(ThemeFeatureFlag) -> Bool
Type Methods
static func parse(Data, warningHandler: (any ThemeParsingWarningHandler)?) throws -> ThemeSettingsInput
static func parse(contentsOf: URL, warningHandler: (any ThemeParsingWarningHandler)?) throws -> ThemeSettingsInput
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
ThemeStylesheet
Initializers
init(name: String, isDarkModeOnly: Bool, css: String)
Instance Properties
var css: String
var isDarkModeOnly: Bool
var name: String
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
Enumerations
AnyCodable
Enumeration Cases
case array([AnyCodable])
case bool(Bool)
case double(Double)
case int(Int)
case null
case object([String : AnyCodable])
case string(String)
Initializers
init(from: Decoder) throws
Instance Properties
var arrayValue: [AnyCodable]?
var boolValue: Bool?
var description: String
var doubleValue: Double?
var intValue: Int?
var isNull: Bool
var objectValue: [String : AnyCodable]?
var stringValue: String?
Instance Methods
func encode(to: Encoder) throws
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
ColorValueInput
Enumeration Cases
case lightDark(light: String, dark: String)
case single(String)
Initializers
init(from: Decoder) throws
Instance Properties
var dark: String
var light: String
Instance Methods
func encode(to: Encoder) throws
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
ThemeBundleLayout
Type Properties
static let builtInNamePrefix: String
static let darkModeStylesheetSuffix: String
static let settingsFileName: String
static let stylesheetExtension: String
Type Methods
static func aliases(forBuiltInTheme: String) -> [String]
static func stylesheets(in: URL) throws -> [ThemeStylesheet]
ThemeParsingContext
Type Properties
static var warningHandler: (any ThemeParsingWarningHandler)?
ThemeSettingValue
Enumeration Cases
case lightDark(light: String, dark: String)
case object([String : ThemeSettingValue])
case value(String)
Initializers
init(from: Decoder) throws
Instance Properties
var hasDarkVariant: Bool
var leafPaths: [[String]]
Instance Methods
func encode(to: Encoder) throws
func flattened(prefix: String, dark: Bool) -> [(name: String, value: String)]
func value(at: [String]) -> ThemeSettingValue?
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
DocCStatic Library
Essentials
Getting Started with DocCStatic
Guides
Configuration Reference
Cross-Package Linking
Custom Themes
Library API
Configuration Reference
StaticDocumentationGenerator
Initializers
init(configuration: Configuration)
Instance Properties
let configuration: Configuration
Instance Methods
func generate() async throws -> GenerationResult
func renderFromArchive(URL) async throws -> GenerationResult
GenerationResult
Initializers
init(outputDirectory: URL, generatedPages: Int, modulesDocumented: Int, symbolsDocumented: Int, articlesGenerated: Int, tutorialsGenerated: Int, warnings: [Warning], searchIndexPath: URL?)
Instance Properties
let articlesGenerated: Int
let generatedPages: Int
var indexPath: URL
let modulesDocumented: Int
let outputDirectory: URL
let searchIndexPath: URL?
let symbolsDocumented: Int
let tutorialsGenerated: Int
let warnings: [Warning]
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
GenerationError
Enumeration Cases
case archiveParsingFailed(String)
case doccNotFound
case symbolGraphGenerationFailed(String)
Instance Properties
var errorDescription: String?
Default Implementations
Error Implementations
Instance Properties
var localizedDescription: String
LocalizedError Implementations
Instance Properties
var failureReason: String?
var helpAnchor: String?
var recoverySuggestion: String?
Rendering
HTMLPageBuilder
Initializers
init(configuration: Configuration, navigationIndex: NavigationIndex?, linkResolver: PageLinkResolver)
Instance Properties
let configuration: Configuration
let linkResolver: PageLinkResolver
let navigationIndex: NavigationIndex?
let sidebarDocument: SidebarDocument?
Instance Methods
func buildPage(from: RenderNode, references: [String : any RenderReference]) throws -> String
Type Properties
static let breadcrumbCollapseLimit: Int
static var chromeToggles: String
static let declarationBreakClass: String
static let declarationParenthesisBreakClass: String
static let eyebrowKindClass: String
static let heroAbstractClass: String
static let navigationMenuToggleIdentifier: String
static let navigationTitleIconClass: String
static let onThisPageContainerClass: String
static let sidebarToggleIdentifier: String
static let topicKindBadgeClass: String
static let topicTitleClass: String
RenderContentHTMLRenderer
Structures
RenderContentHTMLRenderer.InlineResult
Instance Properties
let html: String
let plainText: String
Initializers
init(linkResolver: PageLinkResolver)
Instance Properties
let linkResolver: PageLinkResolver
Instance Methods
func renderBlockContent(RenderBlockContent, references: [String : any RenderReference], depth: Int) -> String
func renderInlineContent([RenderInlineContent], references: [String : any RenderReference], depth: Int) -> InlineResult
Type Properties
static let headerAnchorDescription: String
Type Methods
static func headerAnchor(anchor: String, title: String) -> String
IndexPageBuilder
Structures
IndexPageBuilder.IndexContent
Instance Properties
let bodyHTML: String
let title: String?
IndexPageBuilder.ModuleEntry
Initializers
init(name: String, abstract: String, path: String, symbolCount: Int)
Instance Properties
let abstract: String
let name: String
let path: String
let symbolCount: Int
IndexPageBuilder.TutorialEntry
Initializers
init(title: String, path: String, tutorialCount: Int)
Instance Properties
let path: String
let title: String
let tutorialCount: Int
Initializers
init(configuration: Configuration, embedsSidebar: Bool)
Instance Properties
let configuration: Configuration
let embedsSidebar: Bool
Instance Methods
func buildIndexPage(modules: [ModuleEntry], tutorials: [TutorialEntry], indexContent: IndexContent?) -> String
func loadIndexContent(from: URL) -> IndexContent?
Type Properties
static let indexMarkdownFilename: String
static let moduleStatisticsClass: String
StaticHTMLConsumer
Initializers
init(outputDirectory: URL, configuration: Configuration)
Instance Properties
let configuration: Configuration
var linkResolver: PageLinkResolver
var navigationIndex: NavigationIndex?
let outputDirectory: URL
Instance Methods
func consume(assets: [RenderReferenceType : [any RenderReference]]) throws
func consume(assetsInBundle: DocumentationBundle) throws
func consume(benchmarks: Benchmark) throws
func consume(documentationCoverageInfo: [CoverageDataEntry]) throws
func consume(indexingRecords: [IndexingRecord]) throws
func consume(linkableElementSummaries: [LinkDestinationSummary]) throws
func consume(renderNode: RenderNode) throws
func result() -> GenerationResult
Links
PageLinkResolver
Initializers
init(generatedPagePaths: Set<String>?, externalDocumentation: ExternalDocumentation)
Instance Properties
let externalDocumentation: ExternalDocumentation
let generatedPagePaths: Set<String>?
Instance Methods
func destination(forPage: String, depth: Int) -> String?
func isGenerated(String) -> Bool
Type Properties
static let pageFileName: String
static let unrestricted: PageLinkResolver
Type Methods
static func isAbsoluteOrLocal(String) -> Bool
static func qualifiedSymbolName(ofIdentifier: String) -> String?
static func relativePageURL(String, depth: Int) -> String
static func symbolPathComponents(ofIdentifier: String) -> [String]?
ExternalDocumentation
Initializers
init(mappings: [String : URL], packages: [PackageModules])
init(moduleBaseURLs: [String : URL])
Instance Properties
var isEmpty: Bool
let moduleBaseURLs: [String : URL]
Instance Methods
func baseURL(forModule: String) -> URL?
func url(forPagePath: String) -> String?
Type Properties
static let documentationRoot: String
Type Methods
static func moduleKey(for: String) -> String
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
PackageModules
Initializers
init(name: String, identity: String, modules: [String])
Instance Properties
var identity: String
var modules: [String]
var name: String
Instance Methods
func isNamed(String) -> Bool
Type Properties
static let undocumentedTargetTypes: Set<String>
Type Methods
static func moduleNames(fromDumpPackageJSON: String) -> [String]
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
PackageDependency
Initializers
init(name: String, identity: String, path: String)
Instance Properties
var identity: String
var name: String
var path: String
Type Methods
static func dependencies(fromShowDependenciesJSON: String) -> [PackageDependency]
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
DocLinkPostProcessor
Initializers
init(documentedModules: [String : String], externalURLs: [String : URL], pageLinkResolver: PageLinkResolver)
Instance Properties
let documentedModules: [String : String]
let externalURLs: [String : URL]
let pageLinkResolver: PageLinkResolver
Instance Methods
func process(String, currentDepth: Int) -> String
Type Methods
static func shouldProcess(relativePath: String) -> Bool
Search
SearchIndexBuilder
Structures
SearchIndexBuilder.SearchDocument
Initializers
init(from: any Decoder) throws
init(id: String, title: String, type: String, path: String, summary: String, keywords: [String], module: String?, content: String)
Instance Properties
let content: String
let id: String
let keywords: [String]
let module: String?
let path: String
let summary: String
let title: String
let type: String
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
SearchIndexBuilder.SearchIndex
Initializers
init(from: any Decoder) throws
init(version: String, documents: [SearchDocument])
Instance Properties
let documents: [SearchDocument]
let fields: [String]
let version: String
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
Initializers
init(configuration: Configuration)
Instance Properties
let configuration: Configuration
var index: SearchIndex
Instance Methods
func addToIndex(RenderNode)
func writeIndex(to: URL) throws
Supporting Types
DependencyInclusionPolicy
Enumeration Cases
case all
case exclude([String])
case includeOnly([String])
case none
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
ThemeConfiguration
Initializers
init(accentColour: String, includeDarkMode: Bool, customCSS: String?, themeSettings: ThemeSettings.Root?, stylesheets: [ThemeStylesheet])
init(builtInTheme: ThemeSettings.BuiltInTheme, includeDarkMode: Bool, customCSS: String?)
init(themeSettings: ThemeSettings.Root, stylesheets: [ThemeStylesheet], includeDarkMode: Bool, customCSS: String?)
Instance Properties
var accentColour: String
var customCSS: String?
var includeDarkMode: Bool
var stylesheets: [ThemeStylesheet]
var themeSettings: ThemeSettings.Root?
Instance Methods
func isEnabled(ThemeSettings.FeatureFlag) -> Bool
Type Properties
static let `default`: ThemeConfiguration
static let defaultAccentColour: String
Type Methods
static func loadCustomCSS(from: String) throws -> String
static func resolveTheme(String?, includeDarkMode: Bool, customCSS: String?, warningHandler: (any ThemeParsingWarningHandler)?) throws -> ThemeConfiguration
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
Warning
Initializers
init(severity: Severity, summary: String, source: SourceLocation?, explanation: String?)
Instance Properties
var description: String
let explanation: String?
let severity: Severity
let source: SourceLocation?
let summary: String
Enumerations
Warning.Severity
Enumeration Cases
case note
case warning
Initializers
init?(rawValue: String)
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
RawRepresentable Implementations
Instance Properties
var hashValue: Int
Instance Methods
func hash(into: inout Hasher)
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
SourceLocation
Initializers
init(file: String, line: Int, column: Int?)
Instance Properties
let column: Int?
var description: String
let file: String
let line: Int
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
Structures
NavigationIndex
Structures
NavigationIndex.SchemaVersion
Initializers
init(from: any Decoder) throws
Instance Properties
let major: Int
let minor: Int
let patch: Int
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
Initializers
init(from: any Decoder) throws
Instance Properties
let includedArchiveIdentifiers: [String]?
let interfaceLanguages: [String : [NavigationNode]]
let schemaVersion: SchemaVersion?
Instance Methods
func allModules(language: String) -> [NavigationNode]
func findModule(String, language: String) -> NavigationNode?
Type Methods
static func load(from: URL) throws -> NavigationIndex
static func merge([NavigationIndex]) -> NavigationIndex
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
NavigationNode
Initializers
init(from: any Decoder) throws
Instance Properties
let children: [NavigationNode]?
var id: String
let isBeta: Bool?
let isDeprecated: Bool?
var isExpandable: Bool
let isExternal: Bool?
var isGroupMarker: Bool
var nodeType: NodeType
let path: String?
let title: String
let type: String?
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
NavigationSidebarBuilder
Initializers
init(navigationIndex: NavigationIndex, deprecatedPagePaths: Set<String>)
Instance Methods
func buildNavigationTree() -> String
func buildSidebarDocument(includeSearch: Bool) -> String
Type Properties
static var sidebarScript: String
Type Methods
static func buildFallbackSidebar() -> String
static func rowPaths(in: NavigationIndex) -> Set<String>
static func rowTypes(in: NavigationIndex) -> [String : String]
SidebarDocument
Initializers
init(navigationIndex: NavigationIndex)
Instance Properties
let rowPaths: Set<String>
Instance Methods
func embeddingMarkup(forPagePath: String, depth: Int) -> String
func targetIdentifier(forPagePath: String) -> String?
Type Properties
static let colourSchemeMessage: String
static let colourSchemeStorageKey: String
static let documentClass: String
static let fileName: String
static let focusFilterMessage: String
static let frameClass: String
static let frameTitle: String
static let readyMessage: String
static let rowIdentifierPrefix: String
static var stylesheet: String
Type Methods
static func containerMarkup(content: String) -> String
static func isAvailable(for: NavigationIndex?) -> Bool
static func pagePathKey(String) -> String
static func pagePathKey(of: ResolvedTopicReference) -> String
static func rowIdentifier(forPath: String) -> String
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
SwiftSyntaxHighlighter
Initializers
init()
Instance Methods
func highlight(String) -> String
SymbolKind
Initializers
init(DocumentationNode.Kind)
init?(id: String)
init?(keyword: String)
init?(rawValue: String)
Instance Properties
var badgeCharacter: String
var badgeClass: String
var id: String
var isSymbol: Bool
let kind: DocumentationNode.Kind
var name: String
var rawValue: String
Type Properties
static var allCases: [SymbolKind]
static let article: SymbolKind
static let associatedType: SymbolKind
static let `class`: SymbolKind
static let collection: SymbolKind
static let collectionGroup: SymbolKind
static let deinitializer: SymbolKind
static let dictionary: SymbolKind
static let enumeration: SymbolKind
static let enumerationCase: SymbolKind
static let `extension`: SymbolKind
static let function: SymbolKind
static let globalVariable: SymbolKind
static let initializer: SymbolKind
static let instanceMethod: SymbolKind
static let instanceProperty: SymbolKind
static let instanceSubscript: SymbolKind
static let landingPage: SymbolKind
static let macro: SymbolKind
static let module: SymbolKind
static let namespace: SymbolKind
static let `operator`: SymbolKind
static let `protocol`: SymbolKind
static let root: SymbolKind
static let sampleCode: SymbolKind
static let structure: SymbolKind
static let tutorial: SymbolKind
static let tutorialArticle: SymbolKind
static let typeAlias: SymbolKind
static let typeMethod: SymbolKind
static let typeProperty: SymbolKind
static let typeSubscript: SymbolKind
static let unknown: SymbolKind
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
RawRepresentable Implementations
Instance Properties
var hashValue: Int
Instance Methods
func hash(into: inout Hasher)
TutorialsOverview
Structures
TutorialsOverview.Chapter
Initializers
init(name: String, contentHTML: String, imageHTML: String, topics: [Topic])
Instance Properties
var contentHTML: String
var imageHTML: String
var name: String
var topics: [Topic]
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
TutorialsOverview.Topic
Initializers
init(title: String, url: String, estimatedTime: String?, isArticle: Bool, abstract: String?)
Instance Properties
var abstract: String?
var estimatedTime: String?
var isArticle: Bool
var title: String
var url: String
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
TutorialsOverview.Volume
Initializers
init(name: String?, contentHTML: String, imageHTML: String, chapters: [Chapter])
Instance Properties
var chapters: [Chapter]
var contentHTML: String
var imageHTML: String
var name: String?
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
Operators
static func == (TutorialsOverview, TutorialsOverview) -> Bool
Initializers
init(technology: String, title: String, contentHTML: String, estimatedTime: String?, action: (title: String, url: String)?, imageHTML: String, volumes: [Volume])
Instance Properties
var action: (title: String, url: String)?
var contentHTML: String
var estimatedTime: String?
var imageHTML: String
var technology: String
var title: String
var volumes: [Volume]
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
Enumerations
Badge
Type Properties
static let className: String
Type Methods
static func markup(Variant) -> String
static func markup(variant: String, text: String) -> String
static func status(of: RenderNode) -> Variant?
static func statuses(of: RenderNode) -> Set<Variant>
static func titleTag(Variant) -> String
static func topicMarkup(for: TopicRenderReference, pageStatuses: Set<Variant>) -> String
Enumerations
Badge.Variant
Enumeration Cases
case beta
case deprecated
Initializers
init?(rawValue: String)
Instance Properties
var label: String
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
RawRepresentable Implementations
Instance Properties
var hashValue: Int
Instance Methods
func hash(into: inout Hasher)
ColourSchemeToggle
Type Properties
static var bodyAttribute: String
static let className: String
static let defaultScheme: ColourSchemeToggle.Scheme
static let footerClass: String
static let footerContentClass: String
static let inputName: String
static let legend: String
static let schemeAttribute: String
static var script: String
Type Methods
static func footerMarkup(content: String) -> String
static func stylesheet(includeDarkMode: Bool) -> String
static func toggleMarkup() -> String
Enumerations
ColourSchemeToggle.Scheme
Enumeration Cases
case auto
case dark
case light
Initializers
init?(rawValue: String)
Instance Properties
var label: String
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
RawRepresentable Implementations
Instance Properties
var hashValue: Int
Instance Methods
func hash(into: inout Hasher)
NodeType
Enumeration Cases
case article
case `associatedtype`
case `case`
case `class`
case `deinit`
case dictionary
case `enum`
case `extension`
case `func`
case groupMarker
case `init`
case languageGroup
case `let`
case macro
case method
case module
case namespace
case `operator`
case overview
case property
case `protocol`
case section
case `struct`
case `subscript`
case tutorial
case `typealias`
case union
case unknown
case `var`
Initializers
init(rawValue: String)
Instance Properties
var badgeCharacter: String
var badgeClass: String
var iconSVG: String?
var showsBadge: Bool
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
RawRepresentable Implementations
Initializers
init(from: any Decoder) throws
Instance Properties
var hashValue: Int
Instance Methods
func encode(to: any Encoder) throws
func hash(into: inout Hasher)
OnThisPageNavigation
Type Properties
static let navigationClass: String
static let nextTimelineProperty: String
static let timelineProperty: String
static let topAnchor: String
static let trackingLinePercentage: Int
Type Methods
static func headingRules(anchors: [String]) -> String
static func itemTimelines(index: Int, count: Int) -> String
static func selector(forAnchor: String) -> String
static func timeline(Int) -> String
static func timelineScope(count: Int) -> String
StylesheetLayer
Enumeration Cases
case accent
case base
case colourScheme
case custom
case sidebarDocument
case theme
case themeSettings
Initializers
init?(rawValue: String)
Instance Methods
func marker(part: String?) -> String
Type Properties
static let markerPrefix: String
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
RawRepresentable Implementations
Instance Properties
var hashValue: Int
Instance Methods
func hash(into: inout Hasher)
ThemeResolutionError
Enumeration Cases
case invalidThemeFile(String, String)
case themeNotFound(String, String)
Instance Properties
var description: String
Default Implementations
Error Implementations
Instance Properties
var localizedDescription: String
ThemeSettings
Model Types
ThemeSettings.Root
ThemeSettings.Theme
ThemeSettings.ColorValue
ThemeSettings.Value
ThemeSettings.FeatureFlag
ThemeSettings.Stylesheet
ThemeSettings.WarningHandler
ThemeSettings.StandardErrorWarningHandler
Built-in Themes
ThemeSettings.BuiltInTheme
Enumeration Cases
case classic
case `default`
Initializers
init?(rawValue: String)
Instance Properties
var aliases: [String]
var settings: ThemeSettings.Root
var stylesheets: [ThemeStylesheet]
Type Methods
static func named(String) -> `Self`?
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
RawRepresentable Implementations
Instance Properties
var hashValue: Int
Instance Methods
func hash(into: inout Hasher)
ThemeSettingsParser
Type Methods
static func customProperties(from: ThemeSettings.Root, dark: Bool) -> [(name: String, value: String)]
static func extractVariables(from: ThemeSettings.Root, colorScheme: ColorScheme) -> [String : String]
static func generateCSS(from: ThemeSettings.Root, colorScheme: ColorScheme) -> String
static func generateCSS(from: ThemeSettings.Root, includeDarkMode: Bool) -> String
static func generateDarkModeCSS(from: ThemeSettings.Root) -> String
static func generateLightModeCSS(from: ThemeSettings.Root) -> String
static func parse(Data, warningHandler: (any ThemeParsingWarningHandler)?) throws -> ThemeSettings.Root
static func parse(contentsOf: URL, warningHandler: (any ThemeParsingWarningHandler)?) throws -> ThemeSettings.Root
Enumerations
ThemeSettingsParser.ColorScheme
Enumeration Cases
case auto
case dark
case light
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
TopicTypeIcon
Type Properties
static let className: String
static let lettersAttribute: String
static let symbolIdentifierPrefix: String
static let symbolsClassName: String
static let topicListIconRoles: [String]
static let typeAttribute: String
Type Methods
static func attribute(String, of: String) -> String?
static func content(of: String) -> String
static func letters(for: String) -> String?
static func markup(for: String, additionalClass: String) -> String
static func normalisedType(String) -> String
static func referenceMarkup(for: String, additionalClass: String) -> String
static func referringSVG(String, identifier: String, keepingViewBox: Bool) -> String
static func sharingRepeatedTopicIcons(in: String) -> String
static func svg(for: String) -> String
static func symbol(String, identifier: String) -> String
static func symbolDefinitions(for: some Sequence<String>, additionalDrawings: [(identifier: String, svg: String)]) -> String
static func symbolIdentifier(for: String) -> String
static func topicListIcon(forRole: String) -> String?
TutorialDocument
Type Properties
static let assessmentsClass: String
static let assetContainerClass: String
static let assetItemClass: String
static let buttonClass: String
static let callToActionClass: String
static let chapterClass: String
static let choiceClass: String
static let choiceSubmissionClass: String
static let codePreviewClass: String
static let correctChoiceAttribute: String
static let heroBackgroundDarkProperty: String
static let heroClass: String
static let heroIntroClass: String
static let learningPathClass: String
static let menuToggleClass: String
static let navigationClass: String
static let navigationTitleClass: String
static let overviewClass: String
static let overviewHeroClass: String
static let overviewIntroductionClass: String
static let overviewPageClass: String
static let overviewTitleClass: String
static let pageClass: String
static let questionCompletionClass: String
static let quizClass: String
static let sectionClass: String
static let sectionTimelinePrefix: String
static let sectionTimelineProperty: String
static let sectionsClass: String
static let stepClass: String
static let stepContainerClass: String
static let stepMediaContainerClass: String
static let stepTimelinePrefix: String
static let stepTimelineProperty: String
static let stepsClass: String
static let topicAbstractClass: String
static let topicListClass: String
static let tutorialClass: String
Type Methods
static func anchor(for: String) -> String
static func sectionTimeline(Int) -> String
static func stepTimeline(Int) -> String
Enumerations
TutorialDocument.Text
Type Properties
static let article: String
static let chapters: String
static let checkYourUnderstanding: String
static let close: String
static let currentSection: String
static let currentTutorial: String
static let estimatedTime: String
static let introduction: String
static let introductionAnchor: String
static let next: String
static let nextQuestion: String
static let noPreview: String
static let onThisPage: String
static let openMenu: String
static let overviewIntroduction: String
static let possibleAnswers: String
static let preview: String
static let projectFiles: String
static let submit: String
static let successMessage: String
static let tutorial: String
static let tutorials: String
Type Methods
static func chapter(Int) -> String
static func fullMinutes(Int) -> String
static func question(Int, of: Int) -> String
static func section(Int) -> String
static func sectionTracker(Int, of: Int) -> String
static func shortMinutes(Int) -> String
static func spokenTime(String) -> String
static func step(Int) -> String
TutorialIcon
Enumeration Cases
case article
case checkCircle
case chevron
case close
case diagonalArrow
case download
case genericFile
case inlineChevronDown
case inlineChevronRight
case inlinePlusCircle
case resetCircle
case swiftFile
case timer
case tutorial
case xcode
Initializers
init?(rawValue: String)
Instance Properties
var className: String
Instance Methods
func svg(String) -> String
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
RawRepresentable Implementations
Instance Properties
var hashValue: Int
Instance Methods
func hash(into: inout Hasher)
WordBreak
Type Properties
static let opportunity: String
Type Methods
static func markup(String) -> String
DocCStaticServer
Classes
PreviewServer
Creating a Server
init(rootDirectory: URL, port: Int)
Running the Server
func run() async throws
Properties
let rootDirectory: URL
let port: Int
Default Implementations
Actor Implementations
Instance Methods
func assertIsolated(@autoclosure () -> String, file: StaticString, line: UInt)
func assumeIsolated<T>((isolated Self) throws -> T, file: StaticString, line: UInt) rethrows -> T
func preconditionIsolated(@autoclosure () -> String, file: StaticString, line: UInt)
Structures
HTTPResponse
Creating Success Responses
static func ok(body: Data, contentType: MIMEType, includeBody: Bool) -> HTTPResponse
Creating Error Responses
static var badRequest: HTTPResponse
static var forbidden: HTTPResponse
static var notFound: HTTPResponse
static var methodNotAllowed: HTTPResponse
static var internalServerError: HTTPResponse
Response Properties
let head: HTTPResponseHead
let body: ByteBuffer?
StaticFileHandler
Creating a Handler
init(rootDirectory: URL)
Handling Requests
func handleRequest(uri: String, includeBody: Bool) async -> HTTPResponse
Properties
let rootDirectory: URL
Enumerations
MIMEType
Getting MIME Types
static func from(fileExtension: String) -> MIMEType
Text Formats
case html
case css
case javascript
case plain
case xml
Application Formats
case json
case pdf
case zip
case octetStream
Image Formats
case png
case jpeg
case gif
case svg
case webp
case ico
Font Formats
case woff
case woff2
case ttf
case otf
Multimedia Formats
case mp4
case webm
case mp3
case wav
Initializers
init?(rawValue: String)
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
RawRepresentable Implementations
Instance Properties
var hashValue: Int
Instance Methods
func hash(into: inout Hasher)
/