Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

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

Closed
mattt opened this issue May 18, 2021 · 1 comment · Fixed by #282
Closed

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

mattt opened this issue May 18, 2021 · 1 comment · Fixed by #282
Labels
design Functionality with a design component
Milestone
1.0.0-rc1

Comments

@mattt
Copy link
Contributor

mattt commented May 18, 2021

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 mattt added the design Functionality with a design component label May 18, 2021
@mattt mattt added this to the 1.0.0-rc1 milestone May 18, 2021
@mattt
Copy link
Contributor Author

mattt commented May 18, 2021

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

@mattt mattt mentioned this issue May 18, 2021
Merged
@mattt mattt closed this as completed in #282 Jun 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
design Functionality with a design component
Projects
None yet
Milestone
1.0.0-rc1
Development

Successfully merging a pull request may close this issue.

Style callout delimiters in discussion for HTML output SwiftDocOrg/swift-doc
1 participant
@mattt