I maintain a rather large documentation with a lot of images and am using this great tool to provide a printable doc to users.

When a user reaches the /print_page/ route and the print action is launched before scrolling the page, the images aren't loaded due to the html property "lazy loading".

Is there a way to remove this useful property in order to be sure that every images will be included into the printable preview ?

There's an ongoing issue in the chromium repo related to my problem.

https://bugs.chromium.org/p/chromium/issues/detail?id=875403

Your plugin is helpful and works fine, thanks for that!

There is one point I would like to suggest for enhancement (e.g. as an option to the existing method). I understand that your enumeration of headings is only based on the level of the markdown header, and ignores the nav structure from mkdocs.yml. In addition, your TOC has some visual-only features to reflect this nav structure (like the "Customization" title in https://timvink.github.io/mkdocs-print-site-plugin/print_page.html).

It would be more natural to me to consider the nav structure (and adjust the level of the header). For example, your "Customization" would create a # Customization (i.e. Section 3), and the subjacent pages would be included like ## Adding a print button (i.e. Section 3.1) or ## Adding a PDF button (i.e. Section 3.2).

This quickly pile up on larger projects - I can have from 10-30 empty pages with this like it is now.

Here is an example:

• https://majkinetor.github.io/mm-docs-template/docs.pdf#page=16

Can we have an option to remove them ?

Hi, thank you for the cool library!

I've encountered some table formatting issues.

1. table which is smaller than one page: first page is just left blank

2. table which is bigger than one page: first page is filled properly, but table headers are displayed twice

Hi ❤️! I have mkDocs project on readthedocs. Some markdown files stored in subfolders. Something like this:

docs/
├── index.md
├── article_1.md
├── article_1.assets/
│   └── article_1_picture.png
└── section/
    ├── article_2.md
    └── article_2.assets/
        └── article_2_picture.png

and here is my mkdocs.yaml file:

nav:
  - article_1_title: 'article_1.md'
  - 'section_name':
      - article_2_name: 'section/article_2.md'

For article_1_picture.png all works well, but article_2_picture.png is missing:

Could you help me?

Since for large docs it takes some time (like minute or more) and if you are real time serving that slows down refresh.

It could be good to be able to enable/disable plugin by boolean option. Since mkdocs supports setting config values via Environment variables in next version (https://github.com/mkdocs/mkdocs/issues/1954) this could be set up dynamically depending on needs.

TOC part with sections is rendered totally differently from the other TOC elements.

Take a look at "Extra" in the TOC here:

• https://majkinetor.github.io/mm-docs-template/docs.pdf#page=2

Here are the problems:

1. It can't be clicked
2. It has quote line in it ?
3. It is separated from other TOC elements.

All in all, it looks very ugly, especially with more of them.

Relative links are turned into anchors according to their relative paths, but in the print-page class, the section's id which acts as its anchor is generated according to the page's absolute path. This results in these links not working.

We patched this at the end of url.py by generating all relative anchors (this assumes all of them are unique across the entire site and the paths do not contain --s:

    # Finally, insert new anchor for each page
    page_key_parts = page_key.split('-')
    for k in range(len(page_key_parts)):
        partial_page_key = '-'.join(page_key_parts[k:])
        html = f'<section class="print-page" id="{partial_page_key}">{html}</section>'
    return html

Hi Tim,

Since I added the lightgallery mkdocs plugin to my documentation, I can't use the print-site plugin anymore, because the print-site plugin seems to replace url's incorrectly.

The lightgallery plugin adds the following to my index.html page:

<link href="./assets/theme/css/lightgallery.min.css" rel="stylesheet"/>
<script src="./assets/theme/js/lightgallery.min.js"></script>

Note the ./ before assets. I'm not sure why it's doing this. I don't specify the path to the .css and .js files anywhere directly. I'm assuming lightgallery pulls this from the theme - custom_dir which is set to docs/assets/theme in my case.

In print_page.html created by the print-site plugin, this is then changed to:

<link rel="stylesheet" href="//assets/theme/css/lightgallery.min.css">
<script src="//assets/theme/js/lightgallery.min.js"></script>

While just loading the print_page.html file in the browser doesn't seem to give any issue, when I then use htmlark to convert it into a single .html file with everything embedded into it, it fails, because it then claims the .css and .js for lightgallery can't be found.

I'm not entirely sure whether this is a bug in the print-site plugin or elsewhere to be honest.

I worked around it for now by changing my workflow from:

mkdocs build
htmlark docs_html/print_page.html -o documentation.html

to

mkdocs build
sed -i 's/\/\/assets/assets/g' docs_html/print_page.html
htmlark docs_html/print_page.html -o documentation.html

Hi owners,

Thanks for the excellent plugin. I just found my table of contents are generated many times in my print page.

After debug, I found it caused by my including html several times as mkdocs supported:

--8<-- "./table_7.html"

And this plugin replace simply. This results generate_toc() called several times. A possible fix will be only replace the last due to the previously ones may be included by html file.

In latest version PDF export has truncated top.

This might be due to handling of TOC depth in newest version 1.1.0 but removing toc with add_table_of_contents: false still doesn't fix it (that is, sometimes it does, I guess it depends on the size of the doc).

Here are some screenshots - on all front page is missing and depending on TOC depth there are different outputs. Removing TOC doesn't fix front page problem.

This is with latest material (v7.1.0)

Hi,

First of all, I'm sorry that I can't for sure locate whether this is plugin or Material theme related. However:

When loading any documentation page normally, Material theme reads the site configuration as shown:

When loading print_page.html, Material theme receives this incorrect configuration

Basically, the base path from the base URL gets dropped out when loading the print page. Here's the mentioned line in Material.

Would you have any idea what's going on here? Here is my configuration:

docs_dir: "doc"
theme:
    name: material
    logo: assets/*****
    favicon: assets/*****
    font: false
    features:
        - navigation.tabs
        - navigation.instant
        - search.highlight
        - content.tabs.link
        - content.code.annotate
    shortcuts:
        help: 191    # ?
        next: 78     # n
        previous: 80 # p
        search: 83   # s

use_directory_urls: false

## The following section defines which markdown extensions to use.
markdown_extensions:
  - tables
  - toc:
      permalink: True
      separator: '_'
  - smarty:
      smart_dashes: False
      smart_quotes: False
      smart_angled_quotes: False
      substitutions:
        left-single-quote: '‚'
  - markdown.extensions.abbr
  - markdown.extensions.admonition
  - markdown.extensions.attr_list
  - markdown.extensions.codehilite:
      guess_lang: false
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - markdown.extensions.toc:
      permalink: true
  - pymdownx.caret
  - pymdownx.critic:
      mode: view
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.snippets:
      base_path: doc/
  - mkdocs_graphviz
  - markdown_include.include:
      base_path: docs
  - pymdownx.arithmatex:
      generic: true

## Default plugin configuration
plugins:
  - search
  - glightbox:
      effect: fade
      width: 90vw
      height: 90vh
  - kroki:
      ServerURL: https://*****
      FencePrefix: ""
  - print-site:
      add_cover_page: true

extra_javascript:
  - js/mathjax.js
  - js/tablesort.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/[email protected]/es5/tex-mml-chtml.js

copyright: *****

Thanks!

Can I use this plugin with a custom theme? I.e.

theme:
  name: null
  custom_dir: path/to/basic/plain/theme/main.html

(See below for main.html).

When I do, I get:

Could not find a template context.
Report an issue at https://github.com/timvink/mkdocs-print-site-plugin
And mention the template you're using: None

I saw in get_theme_name() the comment "Supports the case when using overrides (using theme: null)". So I tried:

theme: null

but that renders the one-pager in the default MkDocs theme.

Any ideas? Thanks. (Happy to attempt to delve deeper into the code. But would like to know if it even makes sense for this plugin.)

My main.html:

<!DOCTYPE html>
<html>
<body>
    {{ page.content }}
</body>
</html>

I am using mkdocs-static-i18n to generate multi-language pages, but mkdocs-print-site-plugin only generates the default language for print-page.

Is there a option I can use to generate other languages?