-
Notifications
You must be signed in to change notification settings - Fork 65
Support thematic breaks #791
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
@swift-ci test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This works great when I test it locally with my version of swift-docc (from here)! Just curious, is the thematic break supposed to have more emphasis than the horizontal line between the "Overview" and "Topics" sections?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tested it and it works great!
I added a comment to fix how hr looks by default.
Btw, you missed the docc executable in the testing instructions, if you want to update them:
DOCC_HTML_DIR=/path/to/swift-docc-render/dist swift run docc preview ExampleContent.docc
No, it should probably look the same. Thanks for catching that! |
|
@swift-ci test |
Fixed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
|
@swift-ci test |
Add support for "thematic breaks" using `<hr>`. Resolves: rdar://125507297


Bug/issue #, if applicable: 125507297
Summary
Adds support for rendering "thematic breaks" within content using the
<hr>element.With the corresponding Swift-DocC PR, the markdown syntax for horizontal rules can be used in content to indicate a thematic break within content, and this PR adds rendering support for this.
Example Markdown:
Example rendering:
Dependencies
swiftlang/swift-docc#865
Testing
Steps:
DOCC_HTML_DIR=/path/to/swift-docc-render/dist swift run docc preview ExampleContent.doccand verify that a horizontal rule is rendered in the appropriate placeChecklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
npm test, and it succeeded