SwiftDocOrg / swift-doc

A documentation generator for Swift projects
https://swiftdoc.org
MIT License
1.68k stars 99 forks source link

Support for local html file browsing #304

Open magouyaware opened 3 years ago

magouyaware commented 3 years ago

I was really excited when I came across this project, but quickly realized generated HTML files can't be browsed locally. In looking at issues I came across this: https://github.com/SwiftDocOrg/swift-doc/issues/25#issuecomment-609439333

The workaround of running a local web server just won't work for our use case. We are wanting to bundle documentation with a zip of our SDK that will be browsed locally.

For reasons I can't really take the time to go into, we can't host the source code and documentation publicly.

It would be really awesome if a new parameter could be added to provide output specifically for local file browsing: swift doc generate -local -f html