Documentation
Language: Swift
Documentation
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
DocCStatic Library
Essentials
Getting Started with DocCStatic
Guides
Configuration Reference
Cross-Package Linking
Custom Themes
Library API
Configuration Reference
S
StaticDocumentationGenerator
Initializers
M
init(configuration: Configuration)
Instance Properties
P
let configuration: Configuration
Instance Methods
M
func generate() async throws -> GenerationResult
M
func renderFromArchive(URL) async throws -> GenerationResult
S
GenerationResult
Initializers
M
init(outputDirectory: URL, generatedPages: Int, modulesDocumented: Int, symbolsDocumented: Int, articlesGenerated: Int, tutorialsGenerated: Int, warnings: [Warning], searchIndexPath: URL?)
Instance Properties
P
let articlesGenerated: Int
P
let generatedPages: Int
P
var indexPath: URL
P
let modulesDocumented: Int
P
let outputDirectory: URL
P
let searchIndexPath: URL?
P
let symbolsDocumented: Int
P
let tutorialsGenerated: Int
P
let warnings: [Warning]
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
E
GenerationError
Enumeration Cases
E
case archiveParsingFailed(String)
E
case doccNotFound
E
case symbolGraphGenerationFailed(String)
Instance Properties
P
var errorDescription: String?
Default Implementations
Error Implementations
Instance Properties
P
var localizedDescription: String
LocalizedError Implementations
Instance Properties
P
var failureReason: String?
P
var helpAnchor: String?
P
var recoverySuggestion: String?
Rendering
S
HTMLPageBuilder
Initializers
M
init(configuration: Configuration, navigationIndex: NavigationIndex?)
Instance Properties
P
let configuration: Configuration
P
let navigationIndex: NavigationIndex?
Instance Methods
M
func buildPage(from: RenderNode, references: [String : any RenderReference]) throws -> String
M
func buildTutorialOverviewPage(from: RenderNode, references: [String : any RenderReference]) -> String
M
func buildTutorialPage(from: RenderNode, references: [String : any RenderReference]) -> String
S
RenderContentHTMLRenderer
Structures
S
RenderContentHTMLRenderer.InlineResult
Instance Properties
P
let html: String
P
let plainText: String
Initializers
M
init()
Instance Methods
M
func renderBlockContent(RenderBlockContent, references: [String : any RenderReference], depth: Int) -> String
M
func renderInlineContent([RenderInlineContent], references: [String : any RenderReference], depth: Int) -> InlineResult
S
IndexPageBuilder
Structures
S
IndexPageBuilder.IndexContent
Instance Properties
P
let bodyHTML: String
P
let title: String?
S
IndexPageBuilder.ModuleEntry
Initializers
M
init(name: String, abstract: String, path: String, symbolCount: Int)
Instance Properties
P
let abstract: String
P
let name: String
P
let path: String
P
let symbolCount: Int
S
IndexPageBuilder.TutorialEntry
Initializers
M
init(title: String, path: String, tutorialCount: Int)
Instance Properties
P
let path: String
P
let title: String
P
let tutorialCount: Int
Initializers
M
init(configuration: Configuration)
Instance Properties
P
let configuration: Configuration
Instance Methods
M
func buildIndexPage(modules: [ModuleEntry], tutorials: [TutorialEntry], indexContent: IndexContent?) -> String
M
func loadIndexContent(from: URL) -> IndexContent?
Type Properties
P
static let indexMarkdownFilename: String
C
StaticHTMLConsumer
Initializers
M
init(outputDirectory: URL, configuration: Configuration)
Instance Properties
P
let configuration: Configuration
P
var navigationIndex: NavigationIndex?
P
let outputDirectory: URL
Instance Methods
M
func result() -> GenerationResult
Default Implementations
ConvertOutputConsumer Implementations
Instance Methods
M
func consume(assets: [RenderReferenceType : [any RenderReference]]) throws
M
func consume(assetsInBundle: DocumentationBundle) throws
M
func consume(benchmarks: Benchmark) throws
M
func consume(buildMetadata: BuildMetadata) throws
M
func consume(documentationCoverageInfo: [CoverageDataEntry]) throws
M
func consume(indexingRecords: [IndexingRecord]) throws
M
func consume(linkResolutionInformation: SerializableLinkResolutionInformation) throws
M
func consume(linkableElementSummaries: [LinkDestinationSummary]) throws
M
func consume(renderNode: RenderNode) throws
M
func consume(renderReferenceStore: RenderReferenceStore) throws
Search
S
SearchIndexBuilder
Structures
S
SearchIndexBuilder.SearchDocument
Initializers
M
init(from: any Decoder) throws
M
init(id: String, title: String, type: String, path: String, summary: String, keywords: [String], module: String?, content: String)
Instance Properties
P
let content: String
P
let id: String
P
let keywords: [String]
P
let module: String?
P
let path: String
P
let summary: String
P
let title: String
P
let type: String
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
S
SearchIndexBuilder.SearchIndex
Initializers
M
init(from: any Decoder) throws
M
init(version: String, documents: [SearchDocument])
Instance Properties
P
let documents: [SearchDocument]
P
let fields: [String]
P
let version: String
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
Initializers
M
init(configuration: Configuration)
Instance Properties
P
let configuration: Configuration
P
var index: SearchIndex
Instance Methods
M
func addToIndex(RenderNode)
M
func writeIndex(to: URL) throws
Supporting Types
E
DependencyInclusionPolicy
Enumeration Cases
E
case all
E
case exclude([String])
E
case includeOnly([String])
E
case none
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
S
ThemeConfiguration
Initializers
M
init(accentColour: String, includeDarkMode: Bool, customCSS: String?)
Instance Properties
P
var accentColour: String
P
var customCSS: String?
P
var includeDarkMode: Bool
Type Properties
P
static let `default`: ThemeConfiguration
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
S
Warning
Initializers
M
init(severity: Severity, summary: String, source: SourceLocation?, explanation: String?)
Instance Properties
P
var description: String
P
let explanation: String?
P
let severity: Severity
P
let source: SourceLocation?
P
let summary: String
Enumerations
E
Warning.Severity
Enumeration Cases
E
case note
E
case warning
Initializers
M
init?(rawValue: String)
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
RawRepresentable Implementations
Instance Properties
P
var hashValue: Int
Instance Methods
M
func hash(into: inout Hasher)
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
S
SourceLocation
Initializers
M
init(file: String, line: Int, column: Int?)
Instance Properties
P
let column: Int?
P
var description: String
P
let file: String
P
let line: Int
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
Structures
S
DocLinkPostProcessor
Initializers
M
init(documentedModules: [String : String], externalURLs: [String : URL])
Instance Properties
P
let documentedModules: [String : String]
P
let externalURLs: [String : URL]
Instance Methods
M
func process(String, currentDepth: Int) -> String
S
NavigationIndex
Structures
S
NavigationIndex.SchemaVersion
Initializers
M
init(from: any Decoder) throws
Instance Properties
P
let major: Int
P
let minor: Int
P
let patch: Int
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
Initializers
M
init(from: any Decoder) throws
Instance Properties
P
let includedArchiveIdentifiers: [String]?
P
let interfaceLanguages: [String : [NavigationNode]]
P
let schemaVersion: SchemaVersion?
Instance Methods
M
func allModules(language: String) -> [NavigationNode]
M
func findModule(String, language: String) -> NavigationNode?
Type Methods
M
static func load(from: URL) throws -> NavigationIndex
M
static func merge([NavigationIndex]) -> NavigationIndex
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
S
NavigationNode
Initializers
M
init(from: any Decoder) throws
Instance Properties
P
let children: [NavigationNode]?
P
var id: String
P
let isBeta: Bool?
P
let isDeprecated: Bool?
P
var isExpandable: Bool
P
let isExternal: Bool?
P
var isGroupMarker: Bool
P
var nodeType: NodeType
P
let path: String?
P
let title: String
P
let type: String?
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
S
NavigationSidebarBuilder
Initializers
M
init(navigationIndex: NavigationIndex)
Instance Methods
M
func buildModuleSection(NavigationNode, isCurrentModule: Bool, currentPath: String, depth: Int) -> String
M
func buildMultiModuleSidebar(allModules: [NavigationNode], currentModuleName: String, currentPath: String, depth: Int) -> String
M
func buildSidebar(moduleName: String, currentPath: String, depth: Int) -> String
S
SwiftSyntaxHighlighter
Initializers
M
init()
Instance Methods
M
func highlight(String) -> String
S
SymbolKind
Initializers
M
init(DocumentationNode.Kind)
M
init?(id: String)
M
init?(keyword: String)
M
init?(rawValue: String)
Instance Properties
P
var badgeCharacter: String
P
var badgeClass: String
P
var id: String
P
var isSymbol: Bool
P
let kind: DocumentationNode.Kind
P
var name: String
P
var rawValue: String
Type Properties
P
static var allCases: [SymbolKind]
P
static let article: SymbolKind
P
static let associatedType: SymbolKind
P
static let `class`: SymbolKind
P
static let collection: SymbolKind
P
static let collectionGroup: SymbolKind
P
static let deinitializer: SymbolKind
P
static let dictionary: SymbolKind
P
static let enumeration: SymbolKind
P
static let enumerationCase: SymbolKind
P
static let `extension`: SymbolKind
P
static let function: SymbolKind
P
static let globalVariable: SymbolKind
P
static let initializer: SymbolKind
P
static let instanceMethod: SymbolKind
P
static let instanceProperty: SymbolKind
P
static let instanceSubscript: SymbolKind
P
static let landingPage: SymbolKind
P
static let macro: SymbolKind
P
static let module: SymbolKind
P
static let namespace: SymbolKind
P
static let `operator`: SymbolKind
P
static let `protocol`: SymbolKind
P
static let root: SymbolKind
P
static let sampleCode: SymbolKind
P
static let structure: SymbolKind
P
static let tutorial: SymbolKind
P
static let tutorialArticle: SymbolKind
P
static let typeAlias: SymbolKind
P
static let typeMethod: SymbolKind
P
static let typeProperty: SymbolKind
P
static let typeSubscript: SymbolKind
P
static let unknown: SymbolKind
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
RawRepresentable Implementations
Instance Properties
P
var hashValue: Int
Instance Methods
M
func hash(into: inout Hasher)
Enumerations
E
NodeType
Enumeration Cases
E
case article
E
case `associatedtype`
E
case `case`
E
case `class`
E
case `deinit`
E
case dictionary
E
case `enum`
E
case `extension`
E
case `func`
E
case groupMarker
E
case `init`
E
case languageGroup
E
case `let`
E
case macro
E
case method
E
case module
E
case namespace
E
case `operator`
E
case overview
E
case property
E
case `protocol`
E
case section
E
case `struct`
E
case `subscript`
E
case tutorial
E
case `typealias`
E
case union
E
case unknown
E
case `var`
Initializers
M
init(rawValue: String)
Instance Properties
P
var badgeCharacter: String
P
var badgeClass: String
P
var iconSVG: String?
P
var showsBadge: Bool
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
RawRepresentable Implementations
Initializers
M
init(from: any Decoder) throws
Instance Properties
P
var hashValue: Int
Instance Methods
M
func encode(to: any Encoder) throws
M
func hash(into: inout Hasher)
DocCStaticServer
Classes
C
PreviewServer
Creating a Server
M
init(rootDirectory: URL, port: Int)
Running the Server
M
func run() async throws
Properties
P
let rootDirectory: URL
P
let port: Int
Default Implementations
Actor Implementations
Instance Methods
M
func assertIsolated(@autoclosure () -> String, file: StaticString, line: UInt)
M
func assumeIsolated<T>((isolated Self) throws -> T, file: StaticString, line: UInt) rethrows -> T
M
func preconditionIsolated(@autoclosure () -> String, file: StaticString, line: UInt)
Structures
S
HTTPResponse
Creating Success Responses
M
static func ok(body: Data, contentType: MIMEType, includeBody: Bool) -> HTTPResponse
Creating Error Responses
P
static var badRequest: HTTPResponse
P
static var forbidden: HTTPResponse
P
static var notFound: HTTPResponse
P
static var methodNotAllowed: HTTPResponse
P
static var internalServerError: HTTPResponse
Response Properties
P
let head: HTTPResponseHead
P
let body: ByteBuffer?
S
StaticFileHandler
Creating a Handler
M
init(rootDirectory: URL)
Handling Requests
M
func handleRequest(uri: String, includeBody: Bool) async -> HTTPResponse
Properties
P
let rootDirectory: URL
Enumerations
E
MIMEType
Getting MIME Types
M
static func from(fileExtension: String) -> MIMEType
Text Formats
E
case html
E
case css
E
case javascript
E
case plain
E
case xml
Application Formats
E
case json
E
case pdf
E
case zip
E
case octetStream
Image Formats
E
case png
E
case jpeg
E
case gif
E
case svg
E
case webp
E
case ico
Font Formats
E
case woff
E
case woff2
E
case ttf
E
case otf
Multimedia Formats
E
case mp4
E
case webm
E
case mp3
E
case wav
Initializers
M
init?(rawValue: String)
Default Implementations
Equatable Implementations
Operators
static func != (Self, Self) -> Bool
RawRepresentable Implementations
Instance Properties
P
var hashValue: Int
Instance Methods
M
func hash(into: inout Hasher)
/
DocCStatic Library
/
StaticHTMLConsumer
Framework
ConvertOutputConsumer Implementations
Topics
Instance Methods
F
consume(assets:)
F
consume(assetsInBundle:)
F
consume(benchmarks:)
F
consume(buildMetadata:)
F
consume(documentationCoverageInfo:)
F
consume(indexingRecords:)
F
consume(linkResolutionInformation:)
F
consume(linkableElementSummaries:)
F
consume(renderNode:)
F
consume(renderReferenceStore:)