search

SwiftDocOrg / swift-doc

A documentation generator for Swift projects
https://swiftdoc.org
MIT License
1.68k stars 100 forks source link

Add designs to accommodate all types of callout in discussion in HTML output #281

Closed mattt closed 3 years ago

mattt commented 3 years ago

Swift Markup supports a variety of callouts, including Warning, Note, Precondition and SeeAlso. At the moment, we aren't doing much to visually distinguish these in HTML output. It'd be great to give these some panache ✨

Screen Shot 2021-05-18 at 09 51 56
mattt commented 3 years ago

The SwiftMarkup project includes samples of all callout delimiters supported by Xcode.

$ swift run swift-doc generate path/to/SwiftMarkup  --module-name SwiftMarkup --format html