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

Provide a PDF of each documentation component version #68

Open
mojavelinux opened this issue Oct 24, 2021 · 4 comments
Open

Provide a PDF of each documentation component version #68

mojavelinux opened this issue Oct 24, 2021 · 4 comments

Comments

@mojavelinux
Copy link
Member

Providing a PDF of the documentation makes it easier for visitors to read offline and/or on their reading device. It can also make the documentation easier to browse.

Export each documentation component version as a PDF and provide a link to download it. (If a single PDF is too large, it can be broken up into multiple PDFs, as necessary).

The PDF generation should be handled by an Antora extension that uses one of Asciidoctor's PDF converters. The link should appear next to the expand/collapse icon in the navigation on hover.

@mojavelinux
Copy link
Member Author

In addition to PDF, we should also generate a single (non-chunked) HTML page (which would cover #56). It will likely use a similar mechanism, though I don't want to cause this issue to be held up sorting out the details. Therefore, I think it should be handled as a separate issue.

@mojavelinux
Copy link
Member Author

To be clear, the PDF exporter is currently blocked by the release of Antora 3.

@mojavelinux
Copy link
Member Author

In addition to generating a PDF for a component version, it would be nice if the PDF exporter could also generate a PDF for select pages. That way, we could provide a PDF of the AsciiDoc syntax quick reference as a separate document.

@mojavelinux
Copy link
Member Author

Now this is just waiting on a stable release of Antora Assembler. We anticipate wrapping up that development sometime during the summer (and maybe sooner if stars align).

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