Set a custom display name for the plugin's documentation

swiftlang / swift-docc-plugin

Swift Package Manager command plugin for Swift-DocC

https://swiftpackageindex.com/swiftlang/swift-docc-plugin/documentation/swiftdoccplugin

Apache License 2.0

317 stars 54 forks source link

Set a custom display name for the plugin's documentation #16

Closed ethan-kusters closed 2 years ago

ethan-kusters commented 2 years ago

Summary

With Swift 5.7, Swift-DocC has support for setting a custom display name in documentation. We can use it here to render the top-level page of the plugin's documentation as "Swift-DocC Plugin" instead of "SwiftDocCPlugin".

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

[ ] ~~Added tests~~ NFC
[x] Ran the ./bin/test script and it succeeded
[x] Updated documentation if necessary

ethan-kusters commented 2 years ago

@swift-ci please test

ethan-kusters commented 2 years ago

@swift-ci please test