Skip to content
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

Swift-DocC generation #63

Open
twodayslate opened this issue Mar 14, 2022 · 0 comments
Open

Swift-DocC generation #63

twodayslate opened this issue Mar 14, 2022 · 0 comments

Comments

@twodayslate
Copy link
Owner

With the release of Swift 5.6 documentation generation is now easier

https://www.swift.org/blog/swift-5.6-released/

Swift-DocC Updates

Swift-DocC is now available as a SwiftPM plugin using the new plugin command support. See the documentation to learn how to get started.

In addition, you can now use Swift-DocC to publish static content to GitHub Pages.

Other enhancements include:

The docc command-line tool is now a part of the open-source, release Swift toolchain for macOS and Linux platforms.
Swift-DocC can now build documentation that is compatible with static hosting environments, like GitHub Pages.
Swift-DocC can now produce documentation for executable targets like command-line tools and apps.
Be sure to check out Joseph Heck’s great blog post covering this is in more detail.

It would be great if spr could host this documentation automatically. GitHub pages wouldn't even be needed. Got to think about any security concerns tho...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant