mkdocs-exporter

Changelog

• Fixed the timeout option not being honored (fixes #30)
• Fixed some issues with the pagination on aggregated documents
• Updated dependencies

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v6.1.0...v6.1.1

Changelog

• Aggregator - Cover pages behavior is now configurable (resolves #25)
• Material Theme - Fixed code blocks titles being separated from their body (resolves #26)
• Fixed issues with font kerning (resolves #27)
• Extra arguments can now be passed to the browser via the plugin's configuration
• Updated dependencies

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v6.0.0...v6.1.0

Changelog

• MkDocs Exporter is now a single plugin (there is no longer the need to register exporter-pdf, exporter-extras...)
• All your PDF documents can now be combined into a single one (resolves #12)
• Dropped Python 3.8 support
• Miscellaneous fixes and enhancements
• Rewrote the documentation
• Updated dependencies

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v5.3.1...v6.0.0

Changelog

• Updated dependencies
• Updated documentation
  • Introducting a "Reference" section

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v5.3.0...v5.3.1

Changelog

• Updated dependencies

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v5.2.1...v5.3.0

Changelog

• Improved error handling when compiling SCSS files
• Fixed issues when using old plugins name (such as mkdocs/exporter/extras)
• Improved documentation
  • Enabled social cards
  • Miscellaneous enhancements
• Updated dependencies

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v5.2.0...v5.2.1

Changelog

• The plugins have been renamed to follow MkDocs semantics (by @oprypin via #14)
  • Plugins are now named exporter, exporter-pdf and exporter-extras
  • This is a non-breaking change; a deprecation warning will be thrown if old names are still being used

Contributors

Special thanks to the following contributors, whose efforts and insights have been invaluable in this update:

• @oprypin

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v5.1.0...v5.2.0

Changelog

• Support for relative links in PDF documents (resolves #11)
  • You can now define the url property in the mkdocs/exporter/pdf plugin's configuration; it will be the base URL of all relative links (defaults to site_url).
• Improved error handling
  • Exceptions thrown during the invocation of the render function defined in window.MkDocsExporter no longer fail the rendering; instead, errors are now logged
• Improved logging of browser-related errors
  • You can now easily know why the rendering has timed out
• Documentation
  • Updated MkDocs Macros plugin
  • Enhanced cover templates (added module's version and logo)

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v5.0.0...v5.1.0

Breaking changes

• Dropped support for Python 3.7, the minimum required version is now 3.8.

Changelog

• Now privileging material.extensions as the source of extensions instead of the now deprecated materialx module (resolves #13)
• Introducing the MkDocsExporter window object
  • You can define a render function within it, it will be invoked during the rendering process (for instance, it can be used to render MathJax expressions or Mermaid diagrams so they show up in PDF documents) (resolves #10)
• Added new options to the mkdocs/exporter/pdf plugin
  • browser.headless can be used to toggle the browser's headless mode which can be useful during debugging (defaults to true)
  • browser.timeout defines the timeout of the rendering process in milliseconds (defaults to 60000 for 60 seconds)
• Documentation
  • Introducing the "Samples" section to preview the plugin in action in some common scenarios
    • Diagrams
    • Mathematics
    • Multimedia
• Improved logging messages
• Updated Paged.js from version 0.4.2 to 0.4.3
• Updated Docker images and their dependencies
• Updated dependencies

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v4.1.0...v5.0.0

Changelog

• Updated dependencies

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v4.0.2...v4.1.0

Changelog

• Updated dependencies

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v4.0.1...v4.0.2

Changelog

• Updated dependencies
• mkdocs/exporter/pdf:
  • Resolved some encoding issues (https://github.com/adrienbrignon/mkdocs-exporter/issues/8)

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v4.0.0...v4.0.1

Changelog

• mkdocs/exporter/extras:
  • The configuration is now passed as argument when resolving button's attributes through a function.
• mkdocs/exporter/pdf:
  • Prevented the download link from being broken when not using the use_directory_urls option.

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v3.1.1...v4.0.0

Changelog

• mkdocs/exporter/pdf:
  • Paged.js now explicitly tells Playwright that a page is ready to be printed; this should prevent documents from being mangled under some circumstances.

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v3.1.0...v3.1.1

Changelog

• mkdocs/exporter
  • Updated dependencies
  • Enhanced documentation entries
• mkdocs/exporter/pdf
  • Introducing browser's debug mode
  • Enhanced logging messages

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v3.0.3...v3.1.0

Changelog

• mkdocs/exporter/pdf:
  • No longer expunging script tags during print (resolves #6)

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v3.0.2...v3.0.3

Changelog

• Fixed issues with the event loop when other plugins were interacting with it (#3).

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v3.0.1...v3.0.2

Changelog

• Support for custom themes (based either on material or readthedocs)
  • The mkdocs/exporter plugin now supports a theme property in its configuration to override the MkDocs theme.name property

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v3.0.0...v3.0.1

Changelog

• Should fix asyncio issues when generating PDF documents

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v2.0.2...v3.0.0

Changelog

• Minor performance enhancements

Full changelog: https://github.com/adrienbrignon/mkdocs-exporter/compare/v2.0.1...v2.0.2