init(navigationIndex : NavigationIndex ) init(navigationSidebarDocument
The shared navigation sidebar document and the names that connect it to the pages embedding it.
struct SidebarDocumentOverview
The navigation tree of a documentation site is written once, as a standalone HTML document at the root of the output directory (see file). Every documentation page embeds that document in an <iframe> and selects its own row through the URL fragment, so the current page is highlighted and its ancestors are expanded purely with CSS (:), without JavaScript.
This type is the single authoritative home of the names that the Swift code, the generated stylesheet and the generated scripts must agree on, such as the file name, the row identifier prefix and the post message types. An instance describes which pages have a row of their own in a given navigation index and builds the markup a page uses to embed the shared document.
Topics
let rowPaths : Set<String> rowfunc embeddingMarkup (forPagePath : String, depth: Int) -> String embeddingfunc targetIdentifier (forPagePath : String) -> String? targetstatic let colourSchemeMessage : String colourstatic let colourSchemeStorageKey : String colourlocalStorage key that stores the colour scheme chosen by the reader.static let documentClass : String document<body> element of the shared document.static let fileName : String filestatic let focusFilterMessage : String focusstatic let frameClass : String frame<iframe> that embeds the shared document in a page.static let frameTitle : String framestatic let readyMessage : String readystatic let rowIdentifierPrefix : String rowid attribute of every row in the shared document.static var stylesheet: String stylesheetstatic func containerMarkup (content: String) -> String containerstatic func isAvailable (for: NavigationIndex ?) -> Bool isstatic func pagePathKey (String) -> String pagestatic func pagePathKey (of: ResolvedTopicReference ) -> String pagestatic func rowIdentifier (forPath : String) -> String rowid of the row representing a documentation path.Relationships
Swift.Equatable Swift.Sendable Swift.Sendable Metatype