Expose deeplinks. (#275)

* Expose deeplinks. * Add changelog entry for #275 Co-authored-by: Mattt <[email protected]>
SwiftDocOrg · May 18, 2021 · cc45688 · cc45688
1 parent 4491f5b
commit cc45688
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 9 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -11,8 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Added support for generating documentation for
   private symbols.
-  #266 by @Lukas-Stuehrk
-
+  #266 by @Lukas-Stuehrk.
+- Added anchor links to documentation entries for symbols.
+  #275 by @Lukas-Stuehrk.
+
 ### Fixed
 
 - Fixed bug that caused prefix and postfix operators to be omitted

diff --git a/Sources/swift-doc/Supporting Types/Components/Members.swift b/Sources/swift-doc/Supporting Types/Components/Members.swift
@@ -102,11 +102,12 @@ struct Members: Component {
             
                     \#(section.members.map { member -> HypertextLiteral.HTML in
                         let descriptor = String(describing: type(of: member.api)).lowercased()
+                        let id = member.id.description.lowercased().replacingOccurrences(of: " ", with: "-")
 
                         return #"""
-                        <div role="article" class="\#(descriptor)" id=\#(member.id.description.lowercased().replacingOccurrences(of: " ", with: "-"))>
+                        <div role="article" class="\#(descriptor)" id=\#(id)>
                             <h3>
-                                <code>\#(softbreak(member.name))</code>
+                                <code><a href=\#("#\(id)")>\#(softbreak(member.name))</a></code>
                             </h3>
                             \#(Documentation(for: member, in: module, baseURL: baseURL).html)
                         </div>

diff --git a/Sources/swift-doc/Supporting Types/Components/OperatorImplementations.swift b/Sources/swift-doc/Supporting Types/Components/OperatorImplementations.swift
@@ -69,11 +69,13 @@ struct OperatorImplementations: Component {
                 heading = [operand.type, function.name].compactMap { $0 }.joined(separator: " ")
             }
 
+            let id = implementation.id.description.lowercased().replacingOccurrences(of: " ", with: "-")
+
             return #"""
-                   <div role="article" class="function" id=\#(implementation.id.description.lowercased().replacingOccurrences(of: " ", with: "-"))>
+                   <div role="article" class="function" id=\#(id)>
                        <h3>
-                         \#(heading)
-                         \#(unsafeUnescaped: function.genericWhereClause.map({ #"<small>\#($0.escaped)</small>"# }) ?? "")
+                         <a href=\#("#\(id)")>\#(heading)
+                         \#(unsafeUnescaped: function.genericWhereClause.map({ #"<small>\#($0.escaped)</small>"# }) ?? "")</a>
                        </h3>
                        \#(Documentation(for: implementation, in: module, baseURL: baseURL).html)
                    </div>

diff --git a/Sources/swift-doc/Supporting Types/Pages/ExternalTypePage.swift b/Sources/swift-doc/Supporting Types/Pages/ExternalTypePage.swift
@@ -70,10 +70,12 @@ struct ExternalTypePage: Page {
                     \#(section.members.map { member -> HypertextLiteral.HTML in
                     let descriptor = String(describing: type(of: member.api)).lowercased()
 
+                    let id = member.id.description.lowercased().replacingOccurrences(of: " ", with: "-")
+
                     return #"""
-                           <div role="article" class="\#(descriptor)" id=\#(member.id.description.lowercased().replacingOccurrences(of: " ", with: "-"))>
+                           <div role="article" class="\#(descriptor)" id=\#(id)>
                                <h3>
-                                   <code>\#(softbreak(member.name))</code>
+                                   <code><a href=\#("#\(id)")>\#(softbreak(member.name))</a></code>
                                </h3>
                                \#(Documentation(for: member, in: module, baseURL: baseURL).html)
                            </div>