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

Support an output format that doesn't require running on a server #354

Open
tonyarnold opened this issue Aug 3, 2022 · 5 comments
Open

Comments

@tonyarnold
Copy link

Feature Name

Static Output

Description

I've been looking at using DocC for more general documentation that we ship with our apps. Unfortunately, this is not currently possible as the generated output of DocC is a javascript app that seems to require absolute URLs and references to resources (thus must be hosted on a server).

Motivation

I would really like to be able to open the generated documentation using a file:/// link locally on my machine.

This would allow me to ship a set of DocC generated tutorials and articles in my application's bundle as help documentation.

Importance

Currently, there doesn't seem to be a workaround for the "static" output still needing to be hosted on a server.

Alternatives Considered

No response

@schwa
Copy link

schwa commented Mar 31, 2023

Generating a PDF of a docc project would be a fantastic way to discuss API with co-workers.

@robmathers
Copy link

I'd love to see either a "static" HTML option (anything that could be opened locally in a browser), as well as a PDF renderer. It would certainly help adoption in my company, and I suspect many others. We need the ability to share documents internally without a whole private web host infrastructure, as well as being able to share with customers who might want to see our SDK documentation without having Xcode available to open the archive. Public web hosting infrastructure isn't a great fit.

@muthuveerappanal
Copy link

The offline version of the documentation would be really useful to be used with the Apple's Books app (on the Mac / iOS) for bookmarking, adding notes and annotations as I continue to learn incrementally.

@wti
Copy link

wti commented Mar 6, 2024

The online docs do not support search for text other than symbols.

@quigs-stryker
Copy link

Having a non-hosted format would be very useful for including documentation in FDA-regulated software and avoid a lot of manual formatting/documenting.

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

6 participants