-
Notifications
You must be signed in to change notification settings - Fork 13
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
Initial single-page docs #66
Conversation
Using mkdocs-print-site-plugin: * add a single-page version of the docs under lottie-spec/print_page/ * hide live examples from the consolidated page
The TOC may need some cleanup/tweaking, maybe someone more familiar with mkdocs can take a stab. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the intended discovery path for this? I couldn't find a link anywhere, so ended up looking up the docs.
Maybe we can add a link to index.md
or in the nav bar?
I intentionally left it hidden for now because the TOC may require some extra polishing. But yeah, a link in index.md or nav bar is exactly where I think it should end up. |
I wonder if we can inject a tree processor that cleans up empty sections before the TOC is generated |
AFAICT markdown processors are not applied to plugin output... Maybe we could have a separate mkdocs config just for the single page version? Or a separate mkdocs config for the actual spec content ? |
Added a link in "Where to start". |
I patched the plugin: timvink/mkdocs-print-site-plugin#112 We can reference it as |
Thanks, done! |
Could we use this to make a PDF as well? |
I think it's doable but the process is not exactly straightforward (Chrome printing + Puppeteer): https://timvink.github.io/mkdocs-print-site-plugin/how-to/export-PDF.html#automated-export-using-nodejs-and-chrome |
I guess if someone wants the PDF they could print to file anyway |
The patch got merged, so if they make a release we can switch back to the official package |
Using mkdocs-print-site-plugin:
add a single-page version of the docs under lottie-spec/print_page/
hide live examples from the consolidated page