-
Notifications
You must be signed in to change notification settings - Fork 221
[Feature] Add Basic DocC Documentation Support #5
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
8be8d45
to
00c1e93
Compare
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.
Thanks so much for posting this! This is a great start to having docs for swift-markdown. I just want to make some small edits, and then this can be ready to go, even though this is a "WIP". I think it's useful to merge so we can use it as a baseline to build up documentation for Swift-Markdown over time. I also want to wait until #4 is landed, so we can use that work to enable the doc catalog.
00c1e93
to
1ab1998
Compare
Update with your suggestion. |
1ab1998
to
441a750
Compare
The swift bump version PR #4 is merged into main. And I rebased the branch. It should pass the Linux Test now. Could we run test again on this and merge it if passing the tests? @QuietMisdreavus |
441a750
to
f9e45ab
Compare
@swift-ci Please test |
I think we need to pending this PR until #13 is merged. |
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 looks amazing! Thanks for getting things started here.
f9e45ab
to
0313461
Compare
@swift-ci please 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.
Looks great. Thank you @Kyle-Ye!
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.
Looks great, thanks so much!
Summary
After upgrading the Swift version, we can use DocC to document the Markdown module.
So this PR add a .docc file in Markdown module, add basic DocC support and move the original ./Documentation/BlockDirectives.md to the DocC Hierarchy
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/test
script and it succeeded