Support thematic breaks #865
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
d-ronnqvist
reviewed
Mar 25, 2024
Tests/SwiftDocCTests/Rendering/RenderBlockContent_ThematicBreakTests.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/Model/Rendering/Content/RenderBlockContent.swift
Outdated
Show resolved
Hide resolved
Tests/SwiftDocCTests/Rendering/RenderContentCompilerTests.swift
Outdated
Show resolved
Hide resolved
3 tasks
patshaughnessy
approved these changes
Mar 26, 2024
d-ronnqvist
reviewed
Mar 26, 2024
It does now as of this PR: swiftlang/swift-docc-render#791 :) |
|
@swift-ci Please test |
Fix typo in RenderContentCompilerTests resolve some PR feedback Update Sources/SwiftDocC/Model/Rendering/Content/RenderBlockContent.swift Co-authored-by: David Rönnqvist <[email protected]> add tests with multiple variants of thematic breaks Don't enforce unique filenames for documentation extensions (swiftlang#863) * Allow documentation extensions to have the same name Since documentation extensions' filenames have no impact on the URL of any pages, there's no need to enforce unique filenames for them. DocC currently uses only the filename / last path component of articles to determine if there is a duplicate article. This change excludes doc extensions from that check to allow documentation extensions to have the same filename. rdar://117174884 * Add test to ensure doc extensions can have the same filename Checks that doc extensions with the same filename do not produce a warning and DocC no longer drops the content from one of the files. Update the year in license headers Bump patch version
emilyychenn
force-pushed
the
emily/add-horizontal-rule
branch
from
7f69445 to
505b285
Compare
|
@swift-ci please test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bug/issue #: rdar://124275218
Summary
Markdown supports thematic breaks (aka horizontal rules) that are represented by placing three or more hyphens, asterisks, or underscores on a separate line, surrounded by blank lines. This PR adds support for thematic breaks within Swift DocC, adding a
thematicBreakelement in the render JSON.[Minor fix]: also fixed a consistent typo in RenderContentCompilerTests.
Dependencies
DocC render needs to add support in order to render this thematic break from the render JSON.
Testing
Create a thematic break by add three or more hyphens, asterisks, or underscores on a separate line, surrounded by blank lines, and compile the documentation. The render JSON for the data type should now include an element of type "thematicBreak".
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded