Skip to main content

docums-print-site-plugin

Docums plugin that adds a print page to your site that combines the entire site, allowing for easy export to PDF and standalone HTML. See demo.

Features 🌟

  • Support for docurial theme, including features like instant loading and dark color themes.
  • Support for pagination in PDFs.
  • Many options to customize appearance
  • Option to add a cover page
  • Lightweight, no dependencies.

Setup

Install the plugin using pip3:

pip3 install docums-print-site-plugin

Next, add the following lines to your docums.yml:

plugins:
  - search
  - print-site

⚠️ Make sure to put print-site to the bottom of the plugin list. This is because other plugins might alter your site (like the navigation), and you want these changes included in the print page.

If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. Docums enables it by default if there is no plugins entry set.

Usage

  • Navigate to /print_page/ or print_page.html
  • Export to standalone HTML (see export to HTML)
  • Export to PDF using your browser using File > Print > Save as PDF (see export to PDF)

Documentation

Available at khanhduy1407.github.io/docums-print-site-plugin.

Metadata

Release files for docums-print-site-plugin 2.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for docums-print-site-plugin 2.3
File Size Uploaded Provenance
docums-print-site-plugin-2.3.tar.gz 18.0 kB Without provenance Details

Release files / docums-print-site-plugin-2.3.tar.gz

Download URL docums-print-site-plugin-2.3.tar.gz
Size 18.0 kB
Tags Source
SHA-256 checksum
How to use checksums
371f8e56dc08bc14d0c5b93256a0bfc46cb6cad582a6889cd4ed33eb0e582d7e
BLAKE2b-256 checksum
How to use checksums
d070366a3b6bf0434fbe31d734a493e3028451de24c8096dc5da72775c92dedb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.4

Security for docums-print-site-plugin 2.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.3 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page