-
Notifications
You must be signed in to change notification settings - Fork 54
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
Add offline support #1779
Add offline support #1779
Conversation
Enables pages to be excluded from offline docs
@cwjohnston here's an example of a generated PDF: Sensu Go 5.13 - Sensu Docs.pdf An issue that should be apparent right away is that SVG images aren't rendered by Acrobat. We could replace these with PNGs as needed. |
Hi @rnevius ! I'm working on trying this out -- I seem to have some trouble at the Never mind, I needed to switch to your branch! facepalm |
@hillaryfraley have you switched to this branch? The |
Yes, that was it, thank you -- sorry I didn't realize it sooner. |
It also appears that Acrobat doesn't render/capture emoji (such as the ✅ which is used in supported platform tables). |
This reverts commit 8746711.
* Add initial offline layouts. * Add basic Table of Contents to offline templates * Add instructions for previewing offline docs * Add "offline" key to front matter Enables pages to be excluded from offline docs * Add documentation for offline front matter * Update offline style build process. * Update offline styles * Add offline build script * Update offline styles * Fix language-toggle display for offline docs * Fix tables in offline docs
* Add initial offline layouts. * Add basic Table of Contents to offline templates * Add instructions for previewing offline docs * Add "offline" key to front matter Enables pages to be excluded from offline docs * Add documentation for offline front matter * Update offline style build process. * Update offline styles * Add offline build script * Update offline styles * Fix language-toggle display for offline docs * Fix tables in offline docs
Description
Adds layouts, styles, and build processes for generating offline documentation (e.g. PDFs). For now, PDFs should be generated manually via Adobe Acrobat.
Resolves #1647
Motivation and Context
Customers would like to access Sensu docs offline and on e-reader devices.
Review Instructions
Run a local hugo server with offline layouts
Navigate to
http://localhost:1313/
and select your product/version of choice. Note the URL of this resource.Open Acrobat and File → Create → PDF from Web Page