adrienbrignon/mkdocs-exporter

📝 A plugin for MkDocs that exports your pages as PDF documents.

MkDocs Exporter

A highly-configurable plugin for MkDocs that exports your pages to PDF files.

• Documentation
• PyPI
• Examples

Features

• 🚀 Fast - PDF documents are generated concurrently!
• 🎨 Customizable - full control over the resulting documents
  • Cover pages (supports macros plugin)
  • Define custom scripts and stylesheets to customize your PDF documents
  • Define "buttons" at the top of your documentation pages (example)
  • Compatible with material and readthedocs themes
    • Check out some sample PDF documents here
• ⭐ Powerful - it uses a headless browser and some awesome libraries under the hood to generate PDF files
  • Playwright to automate browsers
  • Paged.js polyfills are included (Paged Media and Generated Content CSS modules)
  • Sass support (via libsass) for your stylesheets

Prerequisites

• Python >= 3.8
• MkDocs >= 1.4

Installation

The plugin is hosted on PyPI and can be installed via pip (or your favourite package manager):

pip install mkdocs-exporter

Usage

Three plugins are currently available:

• exporter (required): base plugin which must precede the others
• exporter-pdf (optional): plugin that exports your pages as individual PDF documents
• exporter-extras (optional): provides extra functionalities (buttons, HTML utilities...)

Example

The following configuration excerpt from mkdocs.yml should cover the basic functionalities of this plugin:

plugins:
  - exporter
  - exporter-pdf:
      concurrency: 8
      covers:
        front: resources/templates/covers/front.html.j2
        back: resources/templates/covers/back.html.j2
      stylesheets:
        - resources/stylesheets/pdf.scss
  - exporter-extras:
      buttons:
        - title: Download as PDF
          enabled: !!python/name:mkdocs_exporter.plugins.pdf.button.enabled
          icon: !!python/name:mkdocs_exporter.plugins.pdf.button.icon
          attributes:
            href: !!python/name:mkdocs_exporter.plugins.pdf.button.href
            download: !!python/name:mkdocs_exporter.plugins.pdf.button.download

Check out a sample PDF generated by this plugin from the default page of the Material for MkDocs theme.
It has been built with some custom CSS and features cover pages.

Roadmap

• Combine all pages as one PDF

Feel free to request additional features by submitting an issue or by contributing through a pull request.

License

This project is licensed under the MIT License (MIT), which you can read here.

mkdocs-exporter's Issues

playwright._impl._api_types.TimeoutError: Timeout 30000ms exceeded.

Hi, @adrienbrignon,

As per your suggestion given in Issue #3, I tried with ubuntu image and the playwright installation finally went fine. Now I see the below timeout issue. Please verify and suggest if any config changes can be done for the plugin to avoid this issue,

File "/usr/local/bin/mkdocs", line 8, in
sys.exit(cli())
^^^^^
File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 1130, in call
return self.main(*args, **kwargs)
^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 1055, in main
rv = self.invoke(ctx)
^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 1657, in invoke
return _process_result(sub_ctx.command.invoke(sub_ctx))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 1404, in invoke
return ctx.invoke(self.callback, **ctx.params)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 760, in invoke
return __callback(*args, **kwargs)
^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/dist-packages/mkdocs/main.py", line 250, in build_command
build.build(cfg, dirty=not clean)
File "/usr/local/lib/python3.11/dist-packages/mkdocs/commands/build.py", line 332, in build
config.plugins.run_event('post_build', config=config)
File "/usr/local/lib/python3.11/dist-packages/mkdocs/plugins.py", line 522, in run_event
result = method(**kwargs)
^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/dist-packages/mkdocs_exporter/plugins/pdf/plugin.py", line 152, in on_post_build
self.loop.run_until_complete(asyncio.gather(*concurrently(self.tasks, max(1, self.config.concurrency or 1))))
File "/usr/local/lib/python3.11/dist-packages/nest_asyncio.py", line 90, in run_until_complete
return f.result()
^^^^^^^^^^
File "/usr/lib/python3.11/asyncio/tasks.py", line 269, in __step
result = coro.throw(exc)
^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/dist-packages/mkdocs_exporter/plugins/pdf/plugin.py", line 148, in limit
return await asyncio.create_task(coroutine)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3.11/asyncio/futures.py", line 287, in await
yield self # This tells Task to wait for completion.
^^^^^^^^^^
File "/usr/lib/python3.11/asyncio/tasks.py", line 339, in __wakeup
future.result()
File "/usr/lib/python3.11/asyncio/futures.py", line 203, in result
raise self._exception.with_traceback(self._exception_tb)
File "/usr/lib/python3.11/asyncio/tasks.py", line 267, in __step
result = coro.send(None)
^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/dist-packages/mkdocs_exporter/plugins/pdf/plugin.py", line 122, in render
pdf = await self.renderer.render(page)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/dist-packages/mkdocs_exporter/plugins/pdf/renderer.py", line 76, in render
return await self.browser.print(html)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/dist-packages/mkdocs_exporter/plugins/pdf/browser.py", line 91, in print
await page.locator('.pagedjs_pages').wait_for(timeout=30000)
File "/usr/local/lib/python3.11/dist-packages/playwright/async_api/_generated.py", line 18010, in wait_for
await self._impl_obj.wait_for(timeout=timeout, state=state)
File "/usr/local/lib/python3.11/dist-packages/playwright/_impl/_locator.py", line 662, in wait_for
await self._frame.wait_for_selector(
File "/usr/local/lib/python3.11/dist-packages/playwright/_impl/_frame.py", line 322, in wait_for_selector
await self._channel.send("waitForSelector", locals_to_params(locals()))
File "/usr/local/lib/python3.11/dist-packages/playwright/_impl/_connection.py", line 61, in send
return await self._connection.wrap_api_call(
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/dist-packages/playwright/_impl/_connection.py", line 482, in wrap_api_call
return await cb()
^^^^^^^^^^
File "/usr/local/lib/python3.11/dist-packages/playwright/_impl/_connection.py", line 97, in inner_send
result = next(iter(done)).result()
^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3.11/asyncio/futures.py", line 203, in result
raise self._exception.with_traceback(self._exception_tb)
playwright._impl._api_types.TimeoutError: Timeout 30000ms exceeded.
=========================== logs ===========================
waiting for locator(".pagedjs_pages") to be visible

I see from some online forums this issue can be fixed if we can increase or disable the timeout value, (timeout = 0).

File "/usr/local/lib/python3.11/dist-packages/mkdocs_exporter/plugins/pdf/browser.py", line 91, in print
await page.locator('.pagedjs_pages').wait_for(timeout=30000)

Please share your thoughts.
Thanks

The way of taking icons will be deprecated, making it impossible to build in strict mode

Hello everyone.

using the mkdocs build --strict --verbose MkDocs command's is impossible to build for the way MkDocs exporter uses emoji. in fact i get this warning

INFO    -  DeprecationWarning: 'materialx.emoji.to_svg' is deprecated.
 Material emoji logic has been officially moved into mkdocs-material
version 9.4. Please use Material's 'material.extensions.emoji.to_svg'
instead of 'materialx.emoji.to_svg' in your 'mkdocs.yml' file.

markdown_extensions:
- pymdownx.emoji:
       emoji_index: !!python/name:material.extensions.emoji.twemoji
       emoji_generator: !!python/name:material.extensions.emoji.to_svg

mkdocs_material_extensions' is deprecated and will no longer be
supported moving forward. This is the last release.

   File "/usr/local/lib/python3.10/dist-packages/mkdocs_exporter/themes/material/icons.py", line 35, in get_icon
     icon = to_svg('twemoji', name, None, None, None, None, None, {}, Markdown())
   File "/usr/local/lib/python3.10/dist-packages/materialx/emoji.py", line 68, in _deprecated_func
    warnings.warn(

 WARNING -  Material emoji logic has been officially moved into mkdocs-material
 version 9.4. Please use Material's 'material.extensions.emoji.to_svg'
 instead of 'materialx.emoji.to_svg' in your 'mkdocs.yml' file.

 markdown_extensions:
  - pymdownx.emoji:
       emoji_index: !!python/name:material.extensions.emoji.twemoji
       emoji_generator: !!python/name:material.extensions.emoji.to_svg

mkdocs_material_extensions' is deprecated and will no longer be supported moving forward. This is the last release.

And it end with Aborted with 1 warnings in strict mode!
So the problem is in /themes/material/icons.py.

Thank you for reading me!

EDIT:
the new library syntax should be from material.extensions.emoji import twemoji, to_svg

Use different color scheme to export PDFs

Suggestion: add a flag that lets users select certain color scheme

For instance, my site defaults to the slate (dark theme) but ideally I'd like the PDF exporter to use the default (light) theme in generating documents

theme:
  palette:
    # - media: "(prefers-color-scheme: dark)"
    - scheme: slate
      accent: amber
      toggle:
        icon: material/brightness-2
        name: "Switch to light mode"
    # - media: "(prefers-color-scheme: light)"
    - scheme: default
      accent: deep purple
      toggle:
        icon: material/brightness-5
        name: "Switch to dark mode"

Read the docs theme support

Would be great to see support for the read the docs theme. Thanks. Read the Docs Theme

Installing with pip ends up with an error (ModuleNotFoundError: No module named '_ctypes')

Tried to install with pip and python3.10 on debian linux

 File "<frozen importlib._bootstrap>", line 1050, in _gcd_import
    File "<frozen importlib._bootstrap>", line 1027, in _find_and_load
    File "<frozen importlib._bootstrap>", line 1006, in _find_and_load_unlocked
    File "<frozen importlib._bootstrap>", line 688, in _load_unlocked
    File "<frozen importlib._bootstrap_external>", line 883, in exec_module
    File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
    File "/tmp/pip-build-env-r85rh432/normal/lib/python3.10/site-packages/wheel/bdist_wheel.py", line 27, in <module>
      from .macosx_libfile import calculate_macosx_platform_tag
    File "/tmp/pip-build-env-r85rh432/normal/lib/python3.10/site-packages/wheel/macosx_libfile.py", line 43, in <module>
      import ctypes
    File "/usr/local/lib/python3.10/ctypes/__init__.py", line 8, in <module>
      from _ctypes import Union, Structure, Array
  ModuleNotFoundError: No module named '_ctypes'

RuntimeError: There is no current event loop in thread 'MainThread'.

Hi,

I have recently switched from mkdocs-with-pdf plugin to your plugin, first I would like to thank you for the contribution.
The below error message is not allowing to proceed further,

File "/usr/local/lib/python3.11/site-packages/mkdocs_exporter/plugins/pdf/plugin.py", line 141, in on_post_build
loop = asyncio.get_event_loop()
^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/asyncio/events.py", line 677, in get_event_loop
raise RuntimeError('There is no current event loop in thread %r.'
RuntimeError: There is no current event loop in thread 'MainThread'.

Could you please check on this one and kindly support to resolve the issue.

mermaid prints as code

Does this plugin render mermaid.js correctly?

My PDFs render Mermaid as code, while the website renders the diagram. Docs here: https://squidfunk.github.io/mkdocs-material/reference/diagrams/

Edit: nevermind, you obviously publish mermaid fine: https://adrienbrignon.github.io/mkdocs-exporter/samples/diagrams/

libsass compilation fails on python 3.11 / macOS 13.4

Hi,

I wanted to try out your plugin and I notice I cannot get it to work on my Macbook.
It's probably an upstream issue.

Is there a way to get the plugin working without the libsass dependency?

Thanks!

Config value 'plugins': Invalid config options for the 'mkdocs/exporter' plugin.

Hi @adrienbrignon,

Hope you remember me, I worked with you for a get_evet_loop issue few weeks back.
I upgraded the plugin version to 3.0.3 and I was using the same mkdocs file given below, I'm receiving the "invalid config" error, please let me know if any other plugin configurations I have to add here in the file,

plugins:
  mkdocs/exporter:
    theme:'material'
  mkdocs/exporter/pdf:
    concurrency: 8
    covers:
      front: resources/templates/covers/front.html.j2
      back: resources/templates/covers/back.html.j2
    stylesheets:
      - resources/stylesheets/pdf.scss
  mkdocs/exporter/extras:
    buttons:
      - title: Download as PDF
        enabled: !!python/name:mkdocs_exporter.plugins.pdf.button.enabled
        icon: !!python/name:mkdocs_exporter.plugins.pdf.button.icon
        attributes:
          href: !!python/name:mkdocs_exporter.plugins.pdf.button.href
          download: !!python/name:mkdocs_exporter.plugins.pdf.button.download

ERROR - Config value 'plugins': Invalid config options for the 'mkdocs/exporter' plugin.
Aborted with 1 Configuration Errors!

Thanks

Unable to get the plugin to work with MKDocs (Material theme)

Issue

Plugin seems unable to generate PDFs

Description

I've installed the plugin using pip, at first run it asked me to update Playwright, so I did. Trying to start the dev server again I got the following error:

Log

Running mkdocs serve gives this output:

INFO     -  Building documentation...
INFO     -  Cleaning site directory
INFO     -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
              - index.md
              - hei.md
              - MicroBit\index.md
              - MicroBit\introduksjontilMicrobit.md
              - Testing\index.md
WARNING  -  A relative path to 'index.html' is included in the 'nav' configuration, which is not found in the documentation files
WARNING  -  A relative path to 'MicroBit/index.html' is included in the 'nav' configuration, which is not found in the documentation files
INFO     -  Rendering PDF for index.md...
INFO     -  Launching browser...
INFO     -  Rendering PDF for MicroBit\index.md...
Traceback (most recent call last):
  File "C:\Program Files\Python310\lib\runpy.py", line 196, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "C:\Program Files\Python310\lib\runpy.py", line 86, in _run_code
    exec(code, run_globals)
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\mkdocs\__main__.py", line 301, in <module>
    cli()
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\click\core.py", line 1130, in __call__
    return self.main(*args, **kwargs)
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\click\core.py", line 1055, in main
    rv = self.invoke(ctx)
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\click\core.py", line 1657, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\click\core.py", line 1404, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\click\core.py", line 760, in invoke
    return __callback(*args, **kwargs)
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\mkdocs\__main__.py", line 234, in serve_command
    serve.serve(dev_addr=dev_addr, livereload=livereload, watch=watch, **kwargs)
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\mkdocs\commands\serve.py", line 83, in serve
    builder(config)
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\mkdocs\commands\serve.py", line 76, in builder
    build(config, live_server=live_server, dirty=dirty)
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\mkdocs\commands\build.py", line 332, in build
    config.plugins.run_event('post_build', config=config)
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\mkdocs\plugins.py", line 522, in run_event
    result = method(**kwargs)
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\mkdocs_exporter\plugins\pdf\plugin.py", line 143, in on_post_build
    loop.run_until_complete(asyncio.gather(*concurrently(self.tasks, max(1, self.config.concurrency or 1))))
  File "C:\Program Files\Python310\lib\asyncio\base_events.py", line 646, in run_until_complete
    return future.result()
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\mkdocs_exporter\plugins\pdf\plugin.py", line 137, in limit
    return await asyncio.create_task(coroutine)
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\mkdocs_exporter\plugins\pdf\plugin.py", line 113, in render
    pdf = await self.renderer.render(page, polyfills=self.config['polyfills'])
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\mkdocs_exporter\plugins\pdf\renderer.py", line 79, in render
    return await self.browser.print(html)
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\mkdocs_exporter\browser.py", line 81, in print
    await page.goto('file://' + file.name, wait_until='networkidle')
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\playwright\async_api\_generated.py", line 9204, in goto
    await self._impl_obj.goto(
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\playwright\_impl\_page.py", line 495, in goto
    return await self._main_frame.goto(**locals_to_params(locals()))
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\playwright\_impl\_frame.py", line 147, in goto
    await self._channel.send("goto", locals_to_params(locals()))
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\playwright\_impl\_connection.py", line 61, in send
    return await self._connection.wrap_api_call(
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\playwright\_impl\_connection.py", line 461, in wrap_api_call
    return await cb()
  File "C:\Users\tor30122\AppData\Roaming\Python\Python310\site-packages\playwright\_impl\_connection.py", line 96, in inner_send
    result = next(iter(done)).result()
playwright._impl._api_types.Error: net::ERR_FAILED at file:///C:/Users/tor30122/AppData/Local/Temp/tmpdm_awifw.html
=========================== logs ===========================
navigating to "file:///C:/Users/tor30122/AppData/Local/Temp/tmpdm_awifw.html", waiting until "networkidle"
============================================================

Configuration

My mkdocs.yml file is:

site_name: IM Boka

nav:
    - Velkommen: 'index.html'
    - MicroBit: 'MicroBit/index.html'

theme:
  name: material
  language: nb
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
#    - navigation.expand
#    - navigation.indexes
#    - navigation.footer
    - content.code.copy

  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: teal
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: teal
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
        primary: teal

extra:
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
    actions:
      - accept
      - reject

copyright: >
  Copyright © 2023 IM Greveskogen –
  <a href="#__consent">Endre cookie innstillinger</a>

plugins:
  - search
  - offline
  - mkdocs-video
  - mkdocs/exporter
  - mkdocs/exporter/pdf
    
markdown_extensions:
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg 
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true 
  - admonition
  - pymdownx.details

Correct macro use

Hello,
I was trying to get you example template to fill in the jinja2 fields but I never could. I made sure mkdocs-macros was installed and I was able to load the config test just fine on my home page with {{ macros_info() }}

When creating the PDFs I get no errors, and the resulting PDF looks perfect, except the field are still just the field {{ whatever }}.

I feel like there's some config I'm missing but I'm at a loss. Any idea where to look next?

Other then that thanks so much for this extension. Makes a beautiful PDF!

Rendering pages with MathJax as PDF

I have a document I'm trying to render as PDF including LaTeX text, but the PDF only shows the raw LaTeX commands. MathJax is configured like here. I feel like this should work already considering this uses a browser to render the page, though. Do I need something else to make this work?

Footnote compatibility

When using a back cover with the footnote extension, footnotes are printed at the top of the back cover. The expected behavior is for the footnotes to appear on the last page.

For example: https://chengcheng-xiao.github.io/onetep-tutorials-mkdocs/tutorials/tutorial_5/tutorial/

FEATURE REQUEST - drawio support

Hey,

Thanks for creating such a useful mkdocs plugin. I really like your work!
As you mentioned on the Repositories README, I would like to request an additional feature:

Currently, I'm using a plugin for embedding drawio diagrams into mkdocs (More Information about the Plugin). Basically, the plugin simplifies the workflow of embedding a diagram by allowing to embed the .drawio file directly instead of exporting the diagram to a .svg and embed this.
I tried to export PDFs with your exporter, which works perfectly fine, but I wasn't able to export a site with the drawio Diagram. There was no Error and the export works, the diagram just wasn't showing in the exported PDF.
So my guess was that this is just not supported by your plugin.

I would be very happy if you could include this feature. Feel free to contact me about further questions or if I can be of assistance.

Idea: use mkdocs-print-page to print all website

I see in the roadmap:

Combine all pages as one PDF

And I know that mkdocs-print-site does one thing: automatically create a page served at /print_page that combine all pages of the site.

I thought I just had to combine your plugins and the print-site one to have a neat pdf of all my documentation.

This failed with a playwright._impl._errors.TimeoutError :( If you ever get curious, you can find the full traceback in this gist.

So I was wondering if you were aware of this print-site-plugin. Anyway, you may want to handle this feature by yourself to get more control of the process.

Not work ?

Hello,

i tried to install your package on my readthedocs repository, but unfortunately it didn't work...
and I don't see a "Download button" (same after adding the part)

The readme is also difficult to understand since there is no "back" file somewhere in the repository
and same if I only add the "front" I have multiple python error
There is also no information about how PDF are generated (during what process ? mkdocs serve? mkdocs build) and where to have it.

Into my mkdocs.yml file,

• I use "nav" for list my markdown file
• my theme: readthedocs (https://mkdocs.readthedocs.io/en/restructure-compat/user-guide/styling-your-docs/)
• my markdown file are stored on docs folder.
• I don't have any other plugin

my python version: 3.8 / mkdocs: the latest

Regards

UnicodeDecodeError: gbk - Illegal Multibyte Sequence

Traceback (most recent call last):
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\runpy.py", line 197, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\runpy.py", line 87, in _run_code
    exec(code, run_globals)
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\Scripts\mkdocs.exe\__main__.py", line 7, in <module>
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\click\core.py", line 1130, in __call__
    return self.main(*args, **kwargs)
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\click\core.py", line 1055, in main
    rv = self.invoke(ctx)
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\click\core.py", line 1657, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\click\core.py", line 1404, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\click\core.py", line 760, in invoke
    return __callback(*args, **kwargs)
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\mkdocs\__main__.py", line 234, in serve_command
    serve.serve(dev_addr=dev_addr, livereload=livereload, watch=watch, **kwargs)
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\mkdocs\commands\serve.py", line 83, in serve
    builder(config)
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\mkdocs\commands\serve.py", line 76, in builder
    build(config, live_server=live_server, dirty=dirty)
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\mkdocs\commands\build.py", line 332, in build
    config.plugins.run_event('post_build', config=config)
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\mkdocs\plugins.py", line 522, in run_event
    result = method(**kwargs)
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\mkdocs_exporter\plugins\pdf\plugin.py", line 151, in on_post_build
    self.loop.run_until_complete(asyncio.gather(*concurrently(self.tasks, max(1, self.config.concurrency or 1))))
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\nest_asyncio.py", line 90, in run_until_complete
    return f.result()
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\asyncio\tasks.py", line 258, in __step
    result = coro.throw(exc)
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\mkdocs_exporter\plugins\pdf\plugin.py", line 147, in limit
    return await asyncio.create_task(coroutine)
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\asyncio\futures.py", line 284, in __await__
    yield self  # This tells Task to wait for completion.
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\asyncio\tasks.py", line 328, in __wakeup
    future.result()
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\asyncio\futures.py", line 201, in result
    raise self._exception
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\asyncio\tasks.py", line 256, in __step
    result = coro.send(None)
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\mkdocs_exporter\plugins\pdf\plugin.py", line 122, in render
    html = self.renderer.preprocess(page)
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\site-packages\mkdocs_exporter\plugins\pdf\renderer.py", line 69, in preprocess
    preprocessor.script(importlib_resources.files(js).joinpath('pagedjs.min.js').read_text())
  File "C:\Users\chenxianrui\AppData\Local\Programs\Python\Python39\lib\pathlib.py", line 1267, in read_text
    return f.read()
UnicodeDecodeError: 'gbk' codec can't decode byte 0xbd in position 6267: illegal multibyte sequence

This error typically occurs when there is an issue with decoding a byte sequence using the 'gbk' codec, which is a character encoding commonly used for simplified Chinese text. It suggests that there might be a problem with the content of the file being processed, possibly due to an encoding mismatch or an invalid multibyte sequence.

I have followed the instruction and installed the prerequisite and when I run the "mkdocs serve", the error msg is above.

Render relative links with a `project_url` setting

Hello,
First of all, I would like to thank you for your work. I was desperate to find a maintained plugin achieving mkdocs -> pdf export.

At the moment, the relatives links are not rendered in pdf. Maybe we could add a project_url optional setting where users could set their root url allowing us to render relatives links.

For instance, say we have somewhere a link toward ../assets/folder/file.txt on documentation page docs/exemple.md hosted at http://mydoc.com/exemple/.

I would set project_url : http://mydoc.com in mkdocs.yml and, in the pdf, the link would direct toward http://mydocs.com/assets/folder/file.txt

I hope my explanations makes some kind of sense.
Thanks again for your work!

PDF How to change first and last page config ?

Hello !

Thank you for your hard work ! it's even better ! 🗜️

I would like to know how to configure the first and last page (the rest of the document is perfect) :

There is a config file somewhere ? or something to change the color/design like you have in: https://adrienbrignon.github.io/mkdocs-exporter/getting-started/index.pdf ?

Regards.