Publish Swift Markdown's documentation to GitHub pages #32
Conversation
This file contains 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
Swift markdown no longer includes a DiagnosticEngine so these links were failing to resolve.
ethan-kusters
requested review from
franklinsch,
Kyle-Ye and
QuietMisdreavus
and removed request for
franklinsch
|
@swift-ci please test |
Kyle-Ye
reviewed
Mar 19, 2022
Kyle-Ye
reviewed
Mar 19, 2022
Kyle-Ye
approved these changes
Mar 19, 2022
3 tasks
| @@ -26,3 +26,5 @@ | |||
|
|
|||
| ## See Also | |||
| - <doc:BlockDirectives> | |||
|
|
|||
| <!-- Copyright (c) 2021-2022 Apple Inc and the Swift Project authors. All Rights Reserved. --> | |||
There was a problem hiding this comment.
I feel like these missing license headers should get their own PR that can be reviewed and merged quickly - my own outstanding PRs here also have commits that add these 😅
|
@swift-ci please test |
franklinsch
approved these changes
Mar 21, 2022
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.
Summary
This sets the foundation for deploying Swift Markdown's documentation to GitHub pages.
Adds the Swift-DocC Plugin as a dependency of Swift-Markdown.
Adds a script to simplify deployment of documentation to GitHub pages.
Moves detailed documentation from the README into the DocC catalog.
After merging this PR, we should be able to prepare a
gh-pagesbranch on the mainswift-markdownrepo with no content on it, run thebin/update-gh-pages-documentation-sitescript and have docs available.Dependencies
None.
Testing
With Swift 5.6, run:
and confirm the Swift-DocC preview works as expected.
I've deployed the documentation to the GitHub pages site on my fork using the included script. Confirm the site behaves as expected here: https://ethan-kusters.github.io/swift-markdown/documentation/markdown/
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded